bpo-28886: doc: Move deprecated abc decorators to separate section #176
Conversation
|
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA). Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow these steps to rectify the issue:
Thanks again to your contribution and we look forward to looking at it! |
Doc/library/abc.rst
Outdated
| @@ -221,6 +221,8 @@ The :mod:`abc` module also provides the following decorators: | |||
| multiple-inheritance. | |||
|
|
|||
|
|
|||
| The :mod:`abc` module also support following legacy builtin decorators: | |||
|
|
|||
There was a problem hiding this comment.
Please fix the small typo: "support" -> "supports the"
|
In addition to the typo, it might be a good idea to describe how their non-abstract counterparts can now simply be applied with |
|
I see. Let me fix this. |
|
@DimitrisJim if we see https://docs.python.org/3.7/library/abc.html it currently describes how the non-abstract counterparts can be applied with
just after the decorator heading can make it more understandable rather than making a separate section. We can add few more lines about how the non-abstract counterparts are working. correct me, if I am wrong anywhere? |
0e43393 to
12962b5
Compare
There was a problem hiding this comment.
Then that section can start with the information on simply applying the builtin decorators on top of the abc.abstractproperty() decorator, before moving on to document the available subclasses.
How about adding one example on the top of the section, and remove three "This special case is deprecated,..."?
|
To try and help move older pull requests forward, we are going through and backfilling 'awaiting' labels on pull requests that are lacking the label. Based on the current reviews, the best we can tell in an automated fashion is that a core developer requested changes to be made to this pull request. If/when the requested changes have been made, please leave a comment that says, |
|
Thanks @harshul1610 for the PR, and @methane for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7. |
…ythonGH-176) (cherry picked from commit 52c6b89) Co-authored-by: Harshul jain <[email protected]>
|
GH-5787 is a backport of this pull request to the 3.7 branch. |
…ythonGH-176) (cherry picked from commit 52c6b89) Co-authored-by: Harshul jain <[email protected]>
|
GH-5788 is a backport of this pull request to the 3.6 branch. |
…H-176) (cherry picked from commit 52c6b89) Co-authored-by: Harshul jain <[email protected]>
…H-176) (cherry picked from commit 52c6b89) Co-authored-by: Harshul jain <[email protected]>
…cframe_nr Move a Py_DECREF to the correct place.
…cframe_nr Move a Py_DECREF to the correct place. (cherry picked from commit f6a512f)
…cframe_nr Move a Py_DECREF to the correct place. (cherry picked from commit f6a512f)
As per the message logs, it is good to add the deprecated decorators to the separate section in
https://docs.python.org/3.7/library/abc.html
https://bugs.python.org/issue28886