Skip to content

Minor documentation fixes #8700

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.

Sign up for GitHub

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
Merged
merged 4 commits into from
Apr 21, 2020
Merged

Minor documentation fixes #8700

merged 4 commits into from
Apr 21, 2020

Conversation

cjolowicz
Copy link
Contributor

Some minor fixes for the Sphinx documentation:

  • two simple typos
  • unintended word repetition/copy-paste error
  • invalid markup (:py:meth: nested inside bold markup)

@cjolowicz
[command_line] Fix typo
dd7e934
@cjolowicz
[final_attrs] Fix typo
7709e6a
@cjolowicz
[extending_mypy] Fix doubled-up words
714fe48
@cjolowicz
[common_issues] Fix unsupported nesting of :py:meth: in bold markup
8d2bb40 
This results in rendering :py:meth: literally in the generated HTML.
Instead, move the method name outside of the bold markup.
@cjolowicz
Copy link
Contributor Author

And thank you for the well-written and comprehensive documentation! 🎉

hauntsaninja
hauntsaninja approved these changes Apr 21, 2020
View reviewed changes
Copy link
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for finding and fixing these!

emmatyping
emmatyping approved these changes Apr 21, 2020
View reviewed changes
Copy link
Member

@emmatyping emmatyping left a comment

Choose a reason for hiding this comment

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

Thanks! Looks good.

@emmatyping emmatyping merged commit 833fc2c into python:master Apr 21, 2020
@cjolowicz cjolowicz deleted the docs-fixes branch April 21, 2020 10:18
@hauntsaninja hauntsaninja mentioned this pull request May 16, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emmatyping emmatyping emmatyping approved these changes

@hauntsaninja hauntsaninja hauntsaninja approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cjolowicz @emmatyping @hauntsaninja