Skip to content

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

@ucodery

Description

@ucodery

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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedWe welcome a contributor to work on this issue! thank you in advance!sprintable

    Type

    No type

    Projects

    Status

    Python Package Guide

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions