README: Documentation improvements #304
Merged
Conversation
This file contains 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
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
di
reviewed
Jun 19, 2022
Comment on lines
+21
to
+34
| * [Features](#features) | ||
| * [Installation](#installation) | ||
| * [Third-party packages](#third-party-packages) | ||
| * [GitHub Actions](#github-actions) | ||
| * [`pre-commit` support](#pre-commit-support) | ||
| * [Usage](#usage) | ||
| * [Exit codes](#exit-codes) | ||
| * [Dry runs](#dry-runs) | ||
| * [Examples](#examples) | ||
| * [Troubleshooting](#troubleshooting) | ||
| * [Security model](#security-model) | ||
| * [Licensing](#licensing) | ||
| * [Contributing](#contributing) | ||
| * [Code of Conduct](#code-of-conduct) |
There was a problem hiding this comment.
Just an FYI that these won't work when the README is displayed on PyPI: pypa/readme_renderer#169
There was a problem hiding this comment.
Yeah, that was in the back of my mind...
IMO that's an acceptable tradeoff for now, since we also direct-link to the repo in a few places (like the GitHub Action).
Signed-off-by: William Woodruff <william@trailofbits.com>
di
approved these changes
Jun 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #303.