✨ Allow configuring description of extra option #1338
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1338 +/- ##
==========================================
+ Coverage 86.87% 88.03% +1.15%
==========================================
Files 56 60 +4
Lines 6532 7086 +554
==========================================
+ Hits 5675 6238 +563
+ Misses 857 848 -9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
danwos
requested changes
Oct 28, 2024
danwos
approved these changes
Oct 28, 2024
chrisjsewell
added a commit
that referenced
this pull request
Jan 26, 2025
Currently, the value of all extra options is expected to be a string; other types are not supported in other aspects of sphinx-needs, such as `needextend` and dynamic functions. This PR adds the `needs. mistyped_external_values ` and `needs.mistyped_import_values` warnings for non-string values, for `needs_external_needs` and `needimport` sources respectively. The warning is only emitted once per source, to avoid creating too many warnings. Note, in the future it is likely that more types will be supported via configuration in `needs_extra_options` (see #1338)
chrisjsewell
added a commit
that referenced
this pull request
Jan 27, 2025
Currently, the value of all extra options is expected to be a string; other types are not supported in various aspects of sphinx-needs (such as `needextend`, dynamic functions and filtering), and in-fact are already silently converted to strings during processing, see: https://github.com/useblocks/sphinx-needs/blob/92b47b129047df1b7aa9f40332d48deb369dc0c2/sphinx_needs/api/need.py#L791 This PR adds the `needs.mistyped_external_values ` and `needs.mistyped_import_values` warnings for non-string values, for `needs_external_needs` and `needimport` sources respectively. The warning is only emitted once per source, to avoid creating too many warnings. Note, in the future it is hoped that more types will be supported via configuration in `needs_extra_options` (see #1338)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR allows for using a dict to define a
needs_extra_optionsitem, that can have both anameand (optional)descriptionkey, e.g.:Note, I envisage this extended dict format eventually also supporting other settings such as a data type, default, and possibly also limiting the need types it applies to, e.g.
These though would require additional code changes