8000 DOC: Update refguide_check note on how to skip code by sethtroisi · Pull Request #15449 · numpy/numpy · GitHub
[go: up one dir, main page]
Skip to content

DOC: Update refguide_check note on how to skip code #15449

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 1 commit into from
Jan 28, 2020
Merged

DOC: Update refguide_check note on how to skip code #15449

merged 1 commit into from
Jan 28, 2020

Conversation

sethtroisi
Copy link
Contributor

Extracted from #15419

@sethtroisi sethtroisi requested a review from rgommers January 27, 2020 19:31
mattip
mattip reviewed Jan 27, 2020
View reviewed changes
eric-wieser
eric-wieser reviewed Jan 27, 2020
View reviewed changes
tools/refguide_check.py Outdated
@@ -947,6 +947,14 @@ def check_doctests_testfile(fname, verbose, ns=None,
Notes
-----

refguide can be signalled to skip testing code by adding '#doctest: +SKIP'
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
refguide can be signalled to skip testing code by adding '#doctest: +SKIP'
refguide can be signalled to skip testing code by adding ``#doctest: +SKIP``

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@sethtroisi sethtroisi mentioned this pull request Jan 28, 2020
Closed
@mattip mattip merged commit 4d1a3a8 into numpy:master Jan 28, 2020
@mattip
Copy link
Member
mattip commented Jan 28, 2020

Thanks @sethtroisi

@sethtroisi sethtroisi deleted the refguide_doc2 branch January 28, 2020 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eric-wieser eric-wieser eric-wieser left review comments

@mattip mattip mattip left review comments

@rgommers rgommers Awaiting requested review from rgommers

Assignees
No one assigned
Labels
04 - Documentation 05 - Testing component: Other
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sethtroisi @mattip @eric-wieser @charris
0