pyOpenSci
Extract out all code examples and use literal includes instead
Whenever a code example is present in this guide, it should be extracted to examples/ and included from there (see #239 for an example).
Only in-line code `like this` or monospace blocks (not code) like our directory outlines should be left within markdown files.
Command-line examples can also be left in. This is at the discretion of the writer. They could be extracted into e.g. .bash files, but if you are trying to show both command and output, that is not a bash script, it is terminal copy and so no longer just code. I also don't know how literalinclude would interact with multiple examples for different systems (#240).
@ucodery i think this has been implemented. Can you confirm? if so we can close it (feel free to close or i will!) if not let's add info related to what is left to do!! 🚀 many thanks for all of the work you've done on the guidebook with adding these applied examples!!!!
It has not. I have extracted examples under pyproject-toml-python-package-metadata.md and code-style-linting-format.md, but I have not worked on any other sections. A rough search still shows about 18 Python code blocks and 38 TOML code blocks.
ok thank you! we can leave it open! if we hold another sprint, perhaps we can provide more detailed instructions here (in the future) to allow others to help?