Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix link to email.message.Message in mailbox docs #60275

Closed
cjerdonek opened this issue Sep 28, 2012 · 8 comments
Closed

fix link to email.message.Message in mailbox docs #60275

cjerdonek opened this issue Sep 28, 2012 · 8 comments
Labels
docs Documentation in the Doc dir easy type-feature A feature request or enhancement

Comments

@cjerdonek
Copy link
Member

BPO 16071
Nosy @warsaw, @bitdancer, @cjerdonek, @kushaldas

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:

assignee = None
closed_at = <Date 2012-09-28.19:23:06.689>
created_at = <Date 2012-09-28.03:21:27.904>
labels = ['easy', 'type-feature', 'docs']
title = 'fix link to email.message.Message in mailbox docs'
updated_at = <Date 2012-09-29.02:13:19.605>
user = 'https://github.com/cjerdonek'

bugs.python.org fields:

activity = <Date 2012-09-29.02:13:19.605>
actor = 'chris.jerdonek'
assignee = 'none'
closed = True
closed_date = <Date 2012-09-28.19:23:06.689>
closer = 'r.david.murray'
components = ['Documentation']
creation = <Date 2012-09-28.03:21:27.904>
creator = 'chris.jerdonek'
dependencies = []
files = []
hgrepos = []
issue_num = 16071
keywords = ['easy']
message_count = 8.0
messages = ['171403', '171520', '171523', '171530', '171531', '171532', '171551', '171552']
nosy_count = 7.0
nosy_names = ['barry', 'r.david.murray', 'chris.jerdonek', 'docs@python', 'Gumnos', 'python-dev', 'kushal.das']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue16071'
versions = ['Python 2.7', 'Python 3.2', 'Python 3.3']
@cjerdonek
Copy link
Member Author

Date: Thu, 13 Sep 2012 00:28:20 -0700
To: docs@python.org
Subject: [docs] Bug in documentation for mailbox module

I think I may have found a minor bug in the documentation for the
mailbox module, at:

http://docs.python.org/library/mailbox.html

Right at the beginning of section 18.4.2. ("Message objects"), when
describing the mailbox.Message class, is the following:

"A subclass of the email.Message module?s *Message*. Subclasses of
mailbox.Message add mailbox-format-specific state and behavior."

The word "Message" indicated above with asterisks is a hyperlink to:

http://docs.python.org/library/mailbox.html#mailbox.Message

I think it should instead link to:

http://docs.python.org/library/email.message.html#email.message.Message

(from: http://mail.python.org/pipermail/docs/2012-September/010520.html )

@cjerdonek cjerdonek added docs Documentation in the Doc dir easy type-feature A feature request or enhancement labels Sep 28, 2012
@kushaldas
Copy link
Member

But the whole 18.4.2 is mount mailbox.Message so, it seems to be correct documentation.
email.Message.Message is properly mentioned in the 4th line properly.
I don't think it is bug.

@cjerdonek
Copy link
Member Author

But the whole 18.4.2 is mount mailbox.Message

But the first reference is a reference to email.Message's Message, so that word should link to email.Message.Message. Sphinx lets you to link to classes, etc. outside the current scope. It's a simple one word or so fix.

@cjerdonek cjerdonek assigned cjerdonek and unassigned docspython Sep 28, 2012
@python-dev
Copy link
Mannequin

python-dev mannequin commented Sep 28, 2012

New changeset be94d100f846 by R David Murray in branch '3.2':
bpo-16071: fix links to email.message.Message in mailbox docs.
http://hg.python.org/cpython/rev/be94d100f846

New changeset 2a14542371b7 by R David Murray in branch 'default':
Merge bpo-16071: fix links to email.message.Message in mailbox docs.
http://hg.python.org/cpython/rev/2a14542371b7

New changeset 70af6b53b52a by R David Murray in branch '3.2':
bpo-16071: fix more email.message links in mailbox docs.
http://hg.python.org/cpython/rev/70af6b53b52a

New changeset f3bd51cdd958 by R David Murray in branch 'default':
Merge bpo-16071: fix more email.message links in mailbox docs.
http://hg.python.org/cpython/rev/f3bd51cdd958

@python-dev
Copy link
Mannequin

python-dev mannequin commented Sep 28, 2012

New changeset aad3cec524f9 by R David Murray in branch '2.7':
bpo-16071: fix email.message links in the mailbox docs.
http://hg.python.org/cpython/rev/aad3cec524f9

@bitdancer
Copy link
Member

Two words and a tilde. But there were also a number of other places where the links were broken. Hopefully I caught them all.

@cjerdonek cjerdonek removed their assignment Sep 28, 2012
@Gumnos
Copy link
Mannequin

Gumnos mannequin commented Sep 29, 2012

http://docs.python.org/library/mailbox.html#mailbox.Message still points to mailbox.Message instead of email.Message "A subclass of the email.Message module’s {bad link}Message{/bad link}"

Not sure if this is a matter of changes that haven't yet been deployed, or just one that slipped through the cracks.

@cjerdonek
Copy link
Member Author

It can take up to 24 hours for the changes to show up on the web site. They are regenerated at least once per day.

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kushaldas @cjerdonek @bitdancer