Skip to content

Docs: double colon at end of paragraph causes doctest directive to display on website #110485

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
wants to merge 1 commit into from

Conversation

GriceTurrble
Copy link

@GriceTurrble GriceTurrble commented Oct 6, 2023

The presence of a double colon is causing .. doctest:: to display in Tutorial 15, Floating Point Arithmetic: Issues and Limitations doc: https://docs.python.org/3/tutorial/floatingpoint.html

image

Removing the colon should allow it to parse the directive properly.


📚 Documentation preview 📚: https://cpython-previews--110485.org.readthedocs.build/

The presence of a double colon is causing `.. doctest::` to outut into the docs themselves.

Removing the colon should allow it to parse properly.
@ghost
Copy link

ghost commented Oct 6, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Oct 6, 2023
@GriceTurrble
Copy link
Author

I see in the preview docs that the directive is no longer displayed 👍
image

@GriceTurrble GriceTurrble changed the title fix: double colon at end of paragraph causes doctest directive to display on website fix(docs): double colon at end of paragraph causes doctest directive to display on website Oct 6, 2023
Copy link
Member

@Eclips4 Eclips4 left a comment

Choose a reason for hiding this comment

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

Thanks!

@Eclips4 Eclips4 changed the title fix(docs): double colon at end of paragraph causes doctest directive to display on website Docs: double colon at end of paragraph causes doctest directive to display on website Oct 7, 2023
@Eclips4
Copy link
Member

Eclips4 commented Oct 8, 2023

Resolved by #110509.
Thanks for your time!

@Eclips4 Eclips4 closed this Oct 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants