Skip to content

Extract out all code examples and use literal includes instead #250

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.

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

Open
ucodery opened this issue May 10, 2024 · 3 comments
Open

Extract out all code examples and use literal includes instead #250

ucodery opened this issue May 10, 2024 · 3 comments
Labels
help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable

Comments

@ucodery
Copy link
Collaborator

ucodery commented May 10, 2024

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 ucodery added help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable labels May 10, 2024
@lwasser lwasser changed the title Extract out all code examples with Extract out all code examples and use literal includes instead May 20, 2024
@lwasser
Copy link
Member

lwasser commented Jul 12, 2024

@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!!!!

@lwasser lwasser changed the title Extract out all code examples and use literal includes instead [possibly completed?] Extract out all code examples and use literal includes instead Jul 12, 2024
@ucodery
Copy link
Collaborator Author

ucodery commented Jul 15, 2024

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.

@lwasser lwasser changed the title [possibly completed?] Extract out all code examples and use literal includes instead Extract out all code examples and use literal includes instead Aug 1, 2024
@lwasser
Copy link
Member

lwasser commented Aug 1, 2024

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable
Projects
Development

No branches or pull requests

2 participants