blackdoc
blackdoc copied to clipboard
keewis
run black on documentation code snippets
Now that it is available, we should test with the new release. Edit: it seems the macos version is not available?
The `doctest` format can appear in both python code and other formats, but docstrings need special attention: naive reformatting may cause triple-quoted strings to conflict with the docstring quotes. To...
Right now, the test suite contains only unit tests, leaving the code in `__main__.py` untested. That code should be moved to a different module and covered by integration tests.
blackdoc currently crashes on ```restructuredtext .. :: >>> @d >>> def f(): pass ``` It could automatically replace the second >>> with ...
The test coverage is not ideal right now: ``` Name Stmts Miss Cover ----------------------------------------------------------- blackdoc/__init__.py 10 5 50% blackdoc/blacken.py 34 22 35% blackdoc/classification.py 13 2 85% blackdoc/formats/__init__.py 20 12 40%...
updates: - [github.com/psf/black: 24.1.1 → 24.3.0](https://github.com/psf/black/compare/24.1.1...24.3.0)
![pre-commit-ci[bot] avatar](https://avatars.githubusercontent.com/in/68672?v=4 "pre-commit-ci[bot] avatar"){kind=avatar}
Bumps [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) from 1.8.12 to 1.8.14. Release notes Sourced from pypa/gh-action-pypi-publish's releases. v1.8.14 🛠️ Internal Dependencies Nothing changed feature-wise. The only notable update is that the underlying container runtime now...
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot] avatar"){kind=avatar}
I'm having a problem with a doctest in one of my repos. We have some doctests where methods are chained, and they are written across multiple lines using the "command...
First off, great repository. Thanks for your work! Now to the issue: Within PyVista, we have a decorator: https://github.com/pyvista/pyvista/blob/451b61c09bbf56f9a55d8e1176986fae361dd7ea/pyvista/plotting/charts.py#L64 This allows us to substitute values in our documentation: https://github.com/pyvista/pyvista/blob/a26a52d037a265774be0ca06bb141e3346e73ad0/pyvista/plotting/charts.py#L1773-L1781 However,...
Some of my doctests include a `# doctest: +SKIP` marker. These markers do not show up in the published docs. However, if these markers exceed the `black` line length, the...
