Closed andresdelfino closed 5 years ago
There are a couple of PEP references with no description in Simple/Compound Statements.
Attached PR fixes this.
My personal opinion is that the PEP title should suffice and that a person can click the link for more detail.
Yeah, I think you are right. The motivation for this PR was to not have two PEPs references in the same line, because, IMHO, it looks somewhat weird. Now, they look like:
"See also: PEP-3115 - Metaclasses in Python 3 PEP-3129 - Class Decorators"
Would a change to make it look like:
""" See also:
PEP-3115 - Metaclasses in Python 3 PEP-3129 - Class Decorators """
be accepted?
New changeset 0f14fc1a7cb2ea0012d0a943e4460acdee2108d7 by Victor Stinner (Andrés Delfino) in branch 'master': bpo-33726, doc: Add short descriptions to PEP references in seealso (GH-7294) https://github.com/python/cpython/commit/0f14fc1a7cb2ea0012d0a943e4460acdee2108d7
New changeset 2a6cf446802079a3ee57147de8273c84d63767e9 by Miss Islington (bot) in branch '3.7': bpo-33726, doc: Add short descriptions to PEP references in seealso (GH-7294) https://github.com/python/cpython/commit/2a6cf446802079a3ee57147de8273c84d63767e9
New changeset 70102ff18817dd3db79cf73a1028251bbf2106f2 by Miss Islington (bot) in branch '3.6': bpo-33726, doc: Add short descriptions to PEP references in seealso (GH-7294) https://github.com/python/cpython/commit/70102ff18817dd3db79cf73a1028251bbf2106f2
Thanks Andrés Delfino!
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields: ```python assignee = None closed_at =
created_at =
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'Add short descriptions to PEP references in seealso'
updated_at =
user = 'https://github.com/andresdelfino'
```
bugs.python.org fields:
```python
activity =
actor = 'vstinner'
assignee = 'docs@python'
closed = True
closed_date =
closer = 'vstinner'
components = ['Documentation']
creation =
creator = 'adelfino'
dependencies = []
files = []
hgrepos = []
issue_num = 33726
keywords = ['patch']
message_count = 7.0
messages = ['318359', '319489', '319490', '328083', '328087', '328088', '328094']
nosy_count = 5.0
nosy_names = ['rhettinger', 'vstinner', 'docs@python', 'adelfino', 'miss-islington']
pr_nums = ['7294', '9980', '9981']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33726'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']
```