Skip to content

bpo-28886: doc: Move deprecated abc decorators to separate section#176

Merged
methane merged 3 commits intopython:masterfrom
harshuljain13:bpo-28886
Feb 21, 2018
Merged

bpo-28886: doc: Move deprecated abc decorators to separate section#176
methane merged 3 commits intopython:masterfrom
harshuljain13:bpo-28886

Conversation

@harshuljain13
Copy link
Copy Markdown
Contributor

@harshuljain13 harshuljain13 commented Feb 19, 2017 •
edited by methane
Loading

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

@the-knights-who-say-ni
Copy link
Copy Markdown

the-knights-who-say-ni commented Feb 19, 2017

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:

  1. Sign the PSF contributor agreement
  2. Wait at least one US business day and then check "Your Details" on bugs.python.org to see if your account has been marked as having signed the CLA (the delay is due to a person having to manually check your signed CLA)
  3. Reply here saying you have completed the above steps

Thanks again to your contribution and we look forward to looking at it!

DimitrisJim
DimitrisJim suggested changes Feb 19, 2017
View reviewed changes
Doc/library/abc.rst Outdated
Copy link
Copy Markdown
Contributor

@DimitrisJim DimitrisJim Feb 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix the small typo: "support" -> "supports the"

@DimitrisJim
Copy link
Copy Markdown
Contributor

DimitrisJim commented Feb 19, 2017

In addition to the typo, it might be a good idea to describe how their non-abstract counterparts can now simply be applied with @abstractmethod, instead of adding a sentence to each class about how this is the case.

@harshuljain13
Copy link
Copy Markdown
Contributor Author

harshuljain13 commented Feb 20, 2017

I see. Let me fix this.

@harshuljain13
Copy link
Copy Markdown
Contributor Author

harshuljain13 commented Feb 20, 2017

@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 @abstractmethod . Do we actually need the separate section? We just need to organize it a little bit. May be, adding the Deprecation line as quoted

Deprecated since version 3.3: It is now possible to use classmethod with abstractmethod(), making this decorator redundant.

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?

@Mariatta Mariatta added docs Documentation in the Doc dir and removed CLA not signed labels Feb 21, 2017
methane
methane previously requested changes Mar 27, 2017
View reviewed changes
Copy link
Copy Markdown
Member

@methane methane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In bpo-28886, @ncoghlan said:

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,..."?

@brettcannon
Copy link
Copy Markdown
Member

brettcannon commented Feb 21, 2018

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, I have made the requested changes; please review again. That will trigger a bot to flag this pull request as ready for a follow-up review.

@methane methane changed the title bpo-28886: Move deprecated abc module decorators to separate section … bpo-28886: doc: Move deprecated abc decorators to separate section Feb 21, 2018
@methane methane merged commit 52c6b89 into python:master Feb 21, 2018
@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Feb 21, 2018

Thanks @harshul1610 for the PR, and @methane for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 21, 2018
@harshuljain13 @miss-islington
bpo-28886: doc: Move deprecated abc decorators to separate section (p…
25f4efd 
…ythonGH-176)

(cherry picked from commit 52c6b89)

Co-authored-by: Harshul jain <harshulrobo@gmail.com>
@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Feb 21, 2018

GH-5787 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 21, 2018
@harshuljain13 @miss-islington
bpo-28886: doc: Move deprecated abc decorators to separate section (p…
7e2f6d9 
…ythonGH-176)

(cherry picked from commit 52c6b89)

Co-authored-by: Harshul jain <harshulrobo@gmail.com>
@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Feb 21, 2018

GH-5788 is a backport of this pull request to the 3.6 branch.

methane pushed a commit that referenced this pull request Feb 21, 2018
@miss-islington @harshuljain13 @methane
bpo-28886: doc: Move deprecated abc decorators to separate section (G…
7452f6d 
…H-176)

(cherry picked from commit 52c6b89)

Co-authored-by: Harshul jain <harshulrobo@gmail.com>
methane pushed a commit that referenced this pull request Feb 21, 2018
@miss-islington @harshuljain13 @methane
bpo-28886: doc: Move deprecated abc decorators to separate section (G…
0150dc5 
…H-176)

(cherry picked from commit 52c6b89)

Co-authored-by: Harshul jain <harshulrobo@gmail.com>
akruis added a commit to akruis/cpython that referenced this pull request Nov 1, 2018
@akruis
Stackless issue python#176: Fix reference counting in stackless.test_…
f6a512f 
…cframe_nr

Move a Py_DECREF to the correct place.
akruis added a commit to akruis/cpython that referenced this pull request Nov 12, 2018
@akruis
Stackless issue python#176: Fix reference counting in stackless.test_…
dd8ac42 
…cframe_nr

Move a Py_DECREF to the correct place.

(cherry picked from commit f6a512f)
akruis added a commit to akruis/cpython that referenced this pull request Feb 18, 2019
@akruis
Stackless issue python#176: Fix reference counting in stackless.test_…
e6fc0e2 
…cframe_nr

Move a Py_DECREF to the correct place.

(cherry picked from commit f6a512f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@methane methane methane left review comments

+1 more reviewer

@DimitrisJim DimitrisJim DimitrisJim requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@harshuljain13 @the-knights-who-say-ni @DimitrisJim @brettcannon @miss-islington @bedevere-bot @methane @Mariatta