This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Add an abstactmethod directive to the Python ReST domain
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: berker.peksag Nosy List: berker.peksag, brett.cannon, docs@python, eric.araujo, eric.snow, georg.brandl, python-dev
Priority: normal Keywords: patch

Created on 2014-04-15 15:57 by eric.snow, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue21240.diff berker.peksag, 2014-04-16 19:01 review
Messages (6)
msg216323 - (view) Author: Eric Snow (eric.snow) * (Python committer) Date: 2014-04-15 15:57
I'd like to be able to mark abstract methods in the docs more explicitly and have their presentation in the docs be more obvious.  So I'd like to propose "abstractmethod" as a new directive to join the existing ones (classmethod, staticmethod, etc.).

(This is motivated by msg216314.)
msg216555 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2014-04-16 19:01
Here's patch. The new PyAbstractMethod class is basically a subclass of the sphinx.domains.python.PyClassmember class which implements the method, classmethod and staticmethod directives.
msg216660 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2014-04-17 06:20
LGTM without having tested it.
msg255902 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2015-12-05 00:00
Are you willing to check this in, Berker? Or is it not needed anymore?
msg256109 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-12-08 10:15
New changeset 1d0d8b27a4e6 by Berker Peksag in branch '3.5':
Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly
https://hg.python.org/cpython/rev/1d0d8b27a4e6

New changeset 84468e1aea61 by Berker Peksag in branch 'default':
Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly
https://hg.python.org/cpython/rev/84468e1aea61
msg256110 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2015-12-08 10:21
Thanks for reminding me of this issue, Brett. I have also updated numbers and selectors docs to use the new directive.
History
Date User Action Args
2022-04-11 14:58:01adminsetgithub: 65439
2015-12-08 10:21:14berker.peksagsetstatus: open -> closed
versions: + Python 3.6, - Python 3.4
messages: + msg256110

resolution: fixed
stage: patch review -> resolved
2015-12-08 10:15:31python-devsetnosy: + python-dev
messages: + msg256109
2015-12-05 00:00:09brett.cannonsetassignee: docs@python -> berker.peksag

messages: + msg255902
nosy: + brett.cannon
2014-04-17 06:20:32georg.brandlsetmessages: + msg216660
2014-04-16 23:04:04eric.araujosetnosy: + eric.araujo
2014-04-16 19:01:26berker.peksagsetfiles: + issue21240.diff

nosy: + berker.peksag
messages: + msg216555

keywords: + patch
stage: patch review
2014-04-15 16:02:42brett.cannonsetnosy: + georg.brandl
2014-04-15 15:57:26eric.snowcreate