Some more doc in python exception #627
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #627 +/- ##
========================================
Coverage 74.05% 74.05%
========================================
Files 27 27
Lines 8018 8018
Branches 1646 1643 -3
========================================
Hits 5938 5938
Misses 1603 1603
Partials 477 477
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
docs/exceptions/python.md
Outdated
| # Python API exceptions | ||
|
|
||
| This feature is available starting in v2.7. To enable it, add the following | ||
| snippet to your code: |
There was a problem hiding this comment.
The wording of the "to enable it" makes it sound like it will be a more permanent feature, which I hope it will not, that's why I put a note about it in the docstring instead as "currently it's an opt-in"
How about the part below this in the docstring inside that note?
There was a problem hiding this comment.
I could not grasp the nuance of that English since I am not good at English.
How about the part below this in the docstring inside that note?
I don't see what you mean.
Could you change as you think the best?
There was a problem hiding this comment.
Ok, updated the documentation with some of the hints you suggested. Also proposing to release 2.8.0 where we switch the default relatively quick so the users would not have to wait to opt-in the exception feature. They could just lock the dependency at 2.7 if they cannot update quickly. But for now having it a bit noisy should help with the visibility that they need to update these, and we can make 2.7.1 release silencing the warning if needed.
Wdyt?
Signed-off-by: Cristian Le <git@lecris.dev>
474a264 to
bfa1c89
Compare
Signed-off-by: Cristian Le <git@lecris.dev>
Signed-off-by: Cristian Le <git@lecris.dev>
Signed-off-by: Cristian Le <git@lecris.dev>
How about this?
Fix #624