Skip to content

deprecate non-list examples - #58

Merged
woutdenolf merged 2 commits into
mainfrom
deprecate_non_list_examples
Oct 23, 2026
Merged

woutdenolf merged 2 commits into
mainfrom
deprecate_non_list_examples

Conversation

@woutdenolf

Copy link
Copy Markdown
Member

PR summary

  • pydantic's Field(examples=...) expects a list of examples
    • pydantic does not validate this
    • TaskDescription validation fails on a non-list value, which makes discovery of the whole package fail
  • Non-list examples are now wrapped in a list with a FutureWarning
    • to become an exception in a future release
  • Found with tomwer (platform_resources in its multicor/multipag models), fixed there separately

AI Disclosure

  • AI tool claude used for all

🤖 Generated with Claude Code

@codecov

codecov Bot commented Oct 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@woutdenolf woutdenolf mentioned this pull request Oct 21, 2026
1 task done
@woutdenolf
woutdenolf requested a review from loichuder October 21, 2026 08:22
Comment thread src/ewokssphinx/ewoks_task_utils.py Outdated
@woutdenolf
woutdenolf requested a review from loichuder October 22, 2026 08:19
@woutdenolf
woutdenolf force-pushed the deprecate_non_list_examples branch from 2a79d29 to f9e8196 Compare October 23, 2026 14:16
@woutdenolf
woutdenolf enabled auto-merge October 23, 2026 14:17
@woutdenolf
woutdenolf merged commit 411f4ef into main Oct 23, 2026
9 checks passed
@woutdenolf
woutdenolf deleted the deprecate_non_list_examples branch October 23, 2026 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants