Skip to content

Documentation for smtplib Missing Italics #101879

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

Closed
utkonos opened this issue Feb 13, 2023 · 1 comment · Fixed by #101886
Closed

Documentation for smtplib Missing Italics #101879

utkonos opened this issue Feb 13, 2023 · 1 comment · Fixed by #101886
Labels
docs Documentation in the Doc dir triaged The issue has been accepted as valid by a triager.

Comments

@utkonos
Copy link
Contributor

utkonos commented Feb 13, 2023

The input parameter source_address for class smtplib.SMTP is missing italics. I was scanning the text looking for the documentation for this input and couldn't find it because I am used to scanning for italics according to the conventions of Python docs. Here is a highlight of the location of the parameter that needs italics.

https://docs.python.org/3/library/smtplib.html#smtplib.SMTP:~:text=raised.%20The%20optional-,source_address,-parameter%20allows%20binding

Linked PRs

@OTheDev
Copy link
Contributor

OTheDev commented Feb 13, 2023

Thanks, I've opened #101886 to fix this!

@terryjreedy terryjreedy added the triaged The issue has been accepted as valid by a triager. label Feb 13, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 26, 2023
terryjreedy pushed a commit that referenced this issue Apr 26, 2023
…tion (GH-101886) (#103888)

gh-101879: docs - italicize argument in smtplib.SMPT() description (GH-101886)
(cherry picked from commit 28a05f4)

Co-authored-by: Owain Davies <[email protected]>
itamaro pushed a commit to itamaro/cpython that referenced this issue Apr 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir triaged The issue has been accepted as valid by a triager.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants