Updated options documentation in README #992
Open
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
BryanH
suggested changes
Dec 11, 2023
| --format | ||
| --force Force new annotations even if there are no changes. | ||
| --frozen Do not allow to change annotations. Exits non-zero if there are going to be changes to files. | ||
| --timestamp Include timestamp in (routes) annotation | ||
| --trace If unable to annotate a file, print the full stack trace, not just the exception message. | ||
| -I, --ignore-columns REGEX don't annotate columns that match a given REGEX (e.g. `annotate -I '^(id|updated_at|created_at)'`) | ||
| --ignore-routes REGEX don't annotate routes that match a given REGEX (e.g. `annotate -I '(mobile|resque|pghero)'`)_ | ||
| -I, --ignore-columns REGEX don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'` |
There was a problem hiding this comment.
The original is correct here; these are examples.
- i.e. (latin: id est), means "in other words"
- e.g. (latin: exemplī grātiā), means "for example"
If we substitute the meaning for the abbreviation, it becomes clearer which one fits.
... don't annotate columns that match a given REGEX (in other words,
annotate -I '^...
... don't annotate columns that match a given REGEX (for example,
annotate -I '^...
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.
Options documentation was out of date. I ran
annotate --helpon the latest version of the gem and updated the documentation.