◐ Shell
reader mode source ↗
Skip to content

bpo-30096: Use ABC in abc reference examples#1220

Merged
merwok merged 3 commits into
python:masterfrom
appeltel:abc-docs-best-practice
Aug 30, 2017
Merged

bpo-30096: Use ABC in abc reference examples#1220
merwok merged 3 commits into
python:masterfrom
appeltel:abc-docs-best-practice

Conversation

@appeltel

@appeltel appeltel commented Apr 20, 2017 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

  • Update example code to use abc.ABC rather than abc.ABCMeta to define abstract base classes.

  • Add examples using both methods in the documentation for abc.ABC.

  • Reorder the documentation of the classes so that the examples make sense when the document is read from top to bottom.

bpo-30096

https://bugs.python.org/issue30096

@appeltel
bpo-30096: Use ABC in abc reference examples …
c0b4a6a 
Update example code to use abc.ABC rather than abc.ABCMeta
to define abstract base classes. Add examples using both
methods in the documentation for abc.ABC. Reorder the
documentation of the classes so that the examples make sense
when the document is read from top to bottom.
@mention-bot

mention-bot commented Apr 20, 2017

Copy link
Copy Markdown

@appeltel, thanks for your PR! By analyzing the history of the files in this pull request, we identified @serhiy-storchaka, @merwok and @birkenfeld to be potential reviewers.

@Mariatta Mariatta added the docs Documentation in the Doc dir label Apr 20, 2017
@rhettinger

rhettinger commented Apr 21, 2017

Copy link
Copy Markdown
Contributor

LGTM

@merwok merwok self-assigned this Aug 30, 2017
merwok
merwok approved these changes Aug 30, 2017
View reviewed changes

@merwok merwok left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

I updated the file to address my minor comment.

@merwok

merwok commented Aug 30, 2017

Copy link
Copy Markdown
Member

I think this change could get a "skip news" label. @Mariatta do you think I interpret the policy right?

@Mariatta

Mariatta commented Aug 30, 2017

Copy link
Copy Markdown
Member

Yes, we can skip news for this. It doesn't require a Misc/News.d entry.
I'll let you add the skip news label :)

@merwok merwok merged commit 122e88a into python:master Aug 30, 2017
@Mariatta

Mariatta commented Aug 30, 2017

Copy link
Copy Markdown
Member

I'm deleting the comment above.

@python python deleted a comment Aug 30, 2017
@merwok

merwok commented Aug 31, 2017

Copy link
Copy Markdown
Member

@appeltel Would you like to do the backport PR?

@appeltel

appeltel commented Sep 4, 2017

Copy link
Copy Markdown
Contributor Author

@merwok - Sure! I'll get that put together.

jimmylai pushed a commit to jimmylai/cpython that referenced this pull request Sep 4, 2017
Merge branch 'master' of https://github.com/python/cpython …
923312f 
* 'master' of https://github.com/python/cpython: (601 commits)
  remove check for bug last seem in Solaris 9 (python#3285)
  Change code owners for hashlib and ssl to the crypto team (python#3284)
  bpo-31281: Fix pathlib.Path incompatibility in fileinput (pythongh-3208)
  remove autoconf check for select() (python#3283)
  remove configure check for 'volatile' (python#3281)
  Add missing _sha3 module to Setup.dist (python#2395)
  bpo-12383: Also ignore __PYVENV_LAUNCHER__ (python#3278)
  bpo-9146: add the missing NEWS entry. (python#3275)
  Fix a c.f.as_completed() refleak previously introduced in bpo-27144 (python#3270)
  bpo-31185: Fixed miscellaneous errors in asyncio speedup module. (python#3076)
  remove a redundant lower in urllib.parse.urlsplit (python#3008)
  bpo-31323: Fix reference leak in test_ssl (python#3263)
  bpo-31250, test_asyncio: fix EventLoopTestsMixin.tearDown() (python#3264)
  bpo-31326: ProcessPoolExecutor waits for the call queue thread (python#3265)
  bpo-27144: concurrent.futures as_complete and map iterators do not keep reference to returned object (python#1560)
  bpo-31250, test_asyncio: fix dangling threads (python#3252)
  bpo-31217: Fix regrtest -R for small integer (python#3260)
  bpo-30096: Use ABC in abc reference examples (python#1220)
  bpo-30737: Update DevGuide links to new URL (pythonGH-3228)
  [Trivial] Remove now redundant assert (python#3245)
  ...
@miss-islington

miss-islington commented Sep 7, 2017

Copy link
Copy Markdown
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 7, 2017
@appeltel @miss-islington
[3.6] bpo-30096: Use ABC in abc reference examples (pythonGH-1220) …
f237126 
Use base class rather than metaclass in examples.
(cherry picked from commit 122e88a)
@bedevere-bot

bedevere-bot commented Sep 7, 2017

Copy link
Copy Markdown

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

Mariatta pushed a commit that referenced this pull request Sep 7, 2017
@miss-islington @Mariatta
[3.6] bpo-30096: Use ABC in abc reference examples (GH-1220) (GH-3408) …
b0d0217 
Use base class rather than metaclass in examples.
(cherry picked from commit 122e88a)
GadgetSteve pushed a commit to GadgetSteve/cpython that referenced this pull request Sep 10, 2017
@appeltel @GadgetSteve
bpo-30096: Use ABC in abc reference examples (python#1220) …
483de77 
Use base class rather than metaclass in examples.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@merwok merwok merwok approved these changes

+1 more reviewer

@auvipy auvipy auvipy approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@merwok merwok

Labels

docs skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@appeltel @mention-bot @rhettinger @merwok @Mariatta @miss-islington @bedevere-bot @auvipy @the-knights-who-say-ni