Skip to content

Issue 250 literal include code examples#667

Open
gchambers11 wants to merge 6 commits into
pyOpenSci:mainfrom
gchambers11:issue_250_literal_include_code_examples
Open

Issue 250 literal include code examples#667
gchambers11 wants to merge 6 commits into
pyOpenSci:mainfrom
gchambers11:issue_250_literal_include_code_examples

Conversation

@gchambers11
Copy link
Copy Markdown

This PR relates to issue #250 which was worked on at pyconus-26.

The code examples in the markdown files in package-structure-code/ and tests/ have been updated to use {literalinclude} as requested in the issue.

Some additional documentation was added to package-structure-code/pyproject-toml-python-package-metadata.md on including dependencies in pyproject.toml which should be reviewed.

The appearance of the code snippets should mostly be unchanged before and after this PR.

Geoffrey Chambers added 3 commits May 18, 2026 11:21
some wordsmithing in pyproject-toml-python-oacjage-metadata.md
updated declare-dependencies.md with literalinclude
updated pyproject.toml to reflect the previous intention with the hard-coded examples as close as possible
added literalinclude pointing to examples/pure-hatch/pyproject.toml
add ipa pronunciations for PyPI
changed literalinclude to reference existing files
add additional commentary on dependencies and dependency-groups
Comment thread package-structure-code/declare-dependencies.md Outdated
@sneakers-the-rat
Copy link
Copy Markdown
Contributor

this looks good, could we update this against main? i want to take a look (i don't want to click the button bc it's not my work)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants