Repository navigation
docs: correct README facts and tidy prose - #57
Merged
Merged
Conversation
- Document that a file of only newlines is truncated to empty - Document exit code 2 and that the path must be a directory - Fix empty inline code cells in the examples table - Install with uv tool install or uvx instead of uv add - Drop the duplicate License section - Sentence-case headings, plain numbered list, no dashes, short contributing note
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
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.
Summary
README fixes for facts that did not match the code, plus prose cleanup.
Changes
eof_fixer/fixer.py:61-63, confirmed by running on a\n\n\nfile: result is 0 bytes). Added to the list and the examples table.2was undocumented: argparse usage errors and a non-directory path (eof_fixer/main.py:22-23) exit 2, confirmed by running on a file and with no argument. Documented, and Usage now says the path must be a directory.uv addmakes eof-fixer a project dependency; Installation now showsuv tool install eof-fixeranduvx eof-fixer ..Checklist
ruff)ty)uv build) if packaging or build config changeddescription, profile blurb) if this touches packaging