Skip to content

Updated options documentation in README #992

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

MatheusPoliCamilo
Copy link

Options documentation was out of date. I ran annotate --help on the latest version of the gem and updated the documentation.

Copy link
Contributor

@BryanH BryanH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please undo the e.g. -> i.e. updates and it should be good.

--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)'`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 '^...

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants