Enable doctest for io.fits narrative docs
See original GitHub issuedoctest-skip
is used quite widely in the io.fits docs (e.g. in docs/io/fits/usage/table.rst). We need to aim to make most of the snippets tested, ideally it would be done easily with the addition of a few small fits files, either to this repo or to data.astropy.org
Issue Analytics
- State:
- Created 6 years ago
- Reactions:4
- Comments:11 (11 by maintainers)
Top Results From Across the Web
doctest — Test interactive Python examples — Python 3.11.1 ...
The doctest module searches for pieces of text that look like interactive Python sessions, and then executes those sessions to verify that they...
Read more >Testing Guidelines — Astropy v1.2.dev14793
The Astropy test suite automatically detects and runs any doctests in the Astropy source code or documentation, or in affiliated packages using the...
Read more >Python's doctest: Document and Test Your Code at Once
With doctest , you can execute test cases from your documentation, your dedicated test files, and the docstrings in your code files. In...
Read more >astropy/testguide.rst at main - GitHub
astropy.test(package='io.fits'). This method works only with package names that can be mapped to Astropy directories. As an alternative you can test a ...
Read more >Doctests · Documenter.jl - JuliaDocs
This section of the manual outlines how to go about enabling doctests for code blocks in your package's documentation.
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@saimn Yes, a new issue would be fine. I planned to work some more on that this weekend but it shouldn’t be forgotten if I don’t have time to finish it.
@pllim - Yes, #6009 urged me to open this issue, as that PR is not a real solution for the problem. Let alone most of the PRs opened through the docs GH integration are generating more work than they solve when opened to the wrong branch.