Issue 250 literal include code examples#667
Open
gchambers11 wants to merge 5 commits into
Open
Conversation
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
|
|
||
| 1. **Required dependencies:** These are dependencies that need to be installed for your package to work correctly in a user's environment. You add these dependencies to the `[project.dependencies]` table in your pyproject.toml file. | ||
| 2. **Feature Dependencies:** These are dependencies that are required if a user wants to access additional functionality (that is not core) to your package. Store these in the `[project.optional.dependencies]` table or your pyproject.toml file. | ||
| 2. **Feature Dependencies:** These are dependencies that are required if a user wants to access additional functionality (that is not core) to your package. Store these in the `[project.project.optional-dependencies]` table or your pyproject.toml file. |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. **Feature Dependencies:** These are dependencies that are required if a user wants to access additional functionality (that is not core) to your package. Store these in the `[project.project.optional-dependencies]` table or your pyproject.toml file. | |
| 2. **Feature Dependencies:** These are dependencies that are required if a user wants to access additional functionality (that is not core) to your package. Store these in the `[project.optional-dependencies]` table or your pyproject.toml file. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR relates to issue #250 which was worked on at pyconus-26.
The code examples in the markdown files in
package-structure-code/andtests/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.mdon including dependencies in pyproject.toml which should be reviewed.The appearance of the code snippets should mostly be unchanged before and after this PR.