Skip to content

Fix documentation references and some typos for email.utils module#149644

Open
Viicos wants to merge 3 commits into
python:mainfrom
Viicos:vp/email-utils-docs
Open

Fix documentation references and some typos for email.utils module#149644
Viicos wants to merge 3 commits into
python:mainfrom
Viicos:vp/email-utils-docs

Conversation

@Viicos
Copy link
Copy Markdown
Contributor

@Viicos Viicos commented May 10, 2026

No description provided.

@Viicos Viicos requested a review from a team as a code owner May 10, 2026 15:25
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels May 10, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs May 10, 2026
@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 10, 2026

Comment thread Doc/library/email.utils.rst Outdated
Comment thread Doc/library/email.utils.rst Outdated
message the date comes from. If the input date has any other valid timezone
offset, the ``datetime`` will be an aware ``datetime`` with the
corresponding a :class:`~datetime.timezone` :class:`~datetime.tzinfo`.
corresponding :class:`~datetime.timezone` :class:`~datetime.tzinfo`.
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.

I don't understand this last sentence actually. Why do we have two classes one after the other?

Copy link
Copy Markdown
Contributor Author

@Viicos Viicos May 10, 2026

Choose a reason for hiding this comment

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

I wasn't entirely sure too. Having a second look, maybe only one was supposed to be written? Maybe it should be:

will be an aware ``datetime`` with the corresponding :attr:`~datetime.datetime.tzinfo attribute`

?

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.

Honestly, I don't know :') could you look at the code and see what it does please?

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.

It's intentional. It is meant to say that a timezone instance is returned as the tzinfo. If you can think of a better why to phrase it, please do ;)

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.

offset, the datetime will be an aware datetime with the
corresponding a :class:~datetime.timezone :class:~datetime.tzinfo.
corresponding :class:~datetime.timezone :class:~datetime.tzinfo.

How about:

   offset, the ``datetime`` will be an aware ``datetime`` whose
   corresponding :attr:`~datetime.datetime.tzinfo` attribute is 
   a :class:`~datetime.timezone` object.

Should i understand it like that?

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.

Yes, that sounds good.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

applied.

Comment thread Doc/library/email.utils.rst Outdated
Viicos added 2 commits May 10, 2026 21:56
Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants