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.

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

Doctest - No clear guidance on how to use the "Option Flag" and and the explanation of "Which Docstrings Are Examined" is ambiguos. #109510

Closed
Unique-Usman opened this issue Sep 17, 2023 · 2 comments
Closed

Doctest - No clear guidance on how to use the "Option Flag" and and the explanation of "Which Docstrings Are Examined" is ambiguos. #109510

Unique-Usman opened this issue Sep 17, 2023 · 2 comments
Labels
docs Documentation in the Doc dir

Comments

@Unique-Usman
Copy link
Contributor

Unique-Usman commented Sep 17, 2023 •
edited by bedevere-app bot

Documentation

Which Docstrings Are Examined :- The issue with the provided documentation lacks clarity and precision. It doesn’t clearly specify what “is true” means in the context of M.test, and it uses unclear language when describing how strings are treated. Additionally, it doesn’t explain why this information is relevant or how it’s practically used.

Option flag :- The documentation provides detailed information about various option flags in doctest, but it lacks real-world examples or scenarios where these flags might be used. Without practical examples, users may find it challenging to understand when and how to apply these flags effectively in their code or documentation testing processes. Providing concrete examples and use cases would greatly enhance the usability of this documentation.

Linked PRs
@Unique-Usman Unique-Usman added the docs Documentation in the Doc dir label Sep 17, 2023
@Unique-Usman
Copy link
Contributor Author

I am currently working on fixing this.

@bedevere-app bedevere-app bot mentioned this issue Sep 21, 2023
Merged
hugovk added a commit that referenced this issue Oct 19, 2023
@Unique-Usman @Mariatta
@JacobCoffee @hugovk @CAM-Gerlach
gh-109510: Clearly explain "Which Docstrings Are Examined" (#109696)
bcc941b 
Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 19, 2023
@Unique-Usman @Mariatta
@JacobCoffee @hugovk @CAM-Gerlach @miss-islington
pythongh-109510: Clearly explain "Which Docstrings Are Examined" (pyt…
0abd7ef 
…honGH-109696)

(cherry picked from commit bcc941b)

Co-authored-by: Unique-Usman <86585626+Unique-Usman@users.noreply.github.com>
Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-app bedevere-app bot mentioned this issue Oct 19, 2023
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 19, 2023
@Unique-Usman @Mariatta
@JacobCoffee @hugovk @CAM-Gerlach @miss-islington
pythongh-109510: Clearly explain "Which Docstrings Are Examined" (pyt…
edfb8d6 
…honGH-109696)

(cherry picked from commit bcc941b)

Co-authored-by: Unique-Usman <86585626+Unique-Usman@users.noreply.github.com>
Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-app bedevere-app bot mentioned this issue Oct 19, 2023
Merged
hugovk added a commit that referenced this issue Oct 19, 2023
@miss-islington @Unique-Usman
@Mariatta @JacobCoffee @hugovk @CAM-Gerlach
[3.12] gh-109510: Clearly explain "Which Docstrings Are Examined" (GH…
3e9d84c 
…-109696) (#111077)

Co-authored-by: Unique-Usman <86585626+Unique-Usman@users.noreply.github.com>
Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
hugovk added a commit that referenced this issue Oct 19, 2023
@miss-islington @Unique-Usman
@Mariatta @JacobCoffee @hugovk @CAM-Gerlach
[3.11] gh-109510: Clearly explain "Which Docstrings Are Examined" (GH…
2b3f9a5 
…-109696) (#111078)

Co-authored-by: Unique-Usman <86585626+Unique-Usman@users.noreply.github.com>
Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@hugovk
Copy link
Member

hugovk commented Nov 9, 2023

Thank you for the fixes!

@hugovk hugovk closed this as completed Nov 9, 2023
aisk pushed a commit to aisk/cpython that referenced this issue Feb 11, 2024
@Unique-Usman @Mariatta
@JacobCoffee @hugovk @CAM-Gerlach @aisk
pythongh-109510: Clearly explain "Which Docstrings Are Examined" (pyt…
b42c982 
…hon#109696)

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hugovk @Unique-Usman