Deprecation warnings #23
Conversation
|
|
||
| - ``caplog.atLevel`` for ``caplog.at_level`` and | ||
| ``caplog.setLevel`` for ``caplog.setLevel`` are still available | ||
| but not supported and deprecated since they don't follow the |
There was a problem hiding this comment.
I guess, deprecated and not supported would be less ambiguous. :)
|
I'm not a |
| @@ -12,6 +12,22 @@ Yet to be released. | |||
|
|
|||
| - [Bugfix] #15 #17 - Restore Python 2.6 compatibility. (Thanks to Marco Nenciarini!) | |||
|
|
|||
| .. attention:: | |||
| Deprecation warnings, these symbols are slated for removal in | |||
| the next major release. | |||
There was a problem hiding this comment.
This sentence reads weird IMHO (it starting with "Deprecation warnings, ..."). I also don't think "symbols" is a common term for Python.
What about: "Deprecation warning: These functions and attributes are slated for ..."?
|
I processed your feedback and reworked the wording a bit. I would appreciate it if someone could read over it again so I can merge this together with the other Pull Requests and Release 1.2.1 from it. Thanks! 😎 |
| @@ -12,6 +12,23 @@ Yet to be released. | |||
|
|
|||
| - [Bugfix] #15 #17 - Restore Python 2.6 compatibility. (Thanks to Marco Nenciarini!) | |||
|
|
|||
| .. attention:: | |||
| Deprecation warnings, these objects (i.e. functions, properties) are | |||
| slated for removal in the next major release. | |||
There was a problem hiding this comment.
I still think starting a sentence with "Deprecation warnings, these objects ..." makes no sense 😉
I think "Deprecation warning: These objects ..." would be better.
|
No-no-no, these must not go into v1.2.1. |
|
Hopefully I got it right this time. |
|
I think, it's worth squashing your follow-up changes into the first commit. |
eisensheng
force-pushed
the
deprecation-warnings
branch
from
06e43e5 to
da38a80
Compare
This adds a longer paragraph regarding the deprecation phase for the changed methods. The
CHANGES.rstfile will also be included in thelong_descriptionfor thesetup.pyfile to warn users only reading the PYPI page.Would be nice to have this reviewed before it lands in develop. English is not my mother language after all. I hate to state this but this makes it a requirement that other review my text IMHO. Thanks!