-
Notifications
You must be signed in to change notification settings - Fork 72
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
♻️ Default to warning for missing needextend ID #1066
Conversation
I'm afraid this change destroys 1-2 use cases. There are situations, where So during a local build, not found |
I would note, with the warning added here, it has the I'll have a think about your use case though Perhaps one could even change the warning subtype, based on if it is strict or not, or something like that; |
@danwos: We cover that use case over our sphinx-warnings-filter extension instead of yet another config option for sphinx-needs. A [needs.extend] warning that can be configured in the sphinx warnings_filter list is imho indeed the cleanest solution. |
b2b1bdd
to
2e6689b
Compare
2e6689b
to
eb2fd18
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1066 +/- ##
==========================================
- Coverage 86.41% 86.33% -0.09%
==========================================
Files 56 56
Lines 6531 6535 +4
==========================================
- Hits 5644 5642 -2
- Misses 887 893 +6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Rather than defaulting to "strict" mode for unknown IDs in
needextend
directives, whereby the entire build is excepted,the default is now changed to "non-strict" mode, and this emits a warning rather than an info log.
I would suggest that actually this deprecates the use of the strict config/directive option, since the user can already halt builds on warnings using the standard
sphinx-build -W
flag.Closes #1025
@arwedus this would mean you could simply remove
needs_needextend_strict = True
and rely on the new default warning behaviour. Make sense?