Update annotated model in README - #385
Open
koeda-ta wants to merge 1 commit into
Open
Conversation
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.
Thank you for developing and maintaining this great gem.
I usually use
annotate, but while reading theAnnotateRbdocumentation, I noticed a section that might be slightly confusing for beginners. I’ve made a small change to address this. Could you please take a look and let me know what you think?Changes
I changed the model file name in the README example as follows:
Reason
Since the environment variable
ANNOTATERB_SKIP_ON_DB_TASKSis introduced immediately aftertask.rb, readers might assume thattask.rbandDB_TASKSare related.However,
task.rbis the name of a model file, whileDB_TASKSrefers to database-related Rake tasks. The two are unrelated.Additionally, the
Usermodel is already used as an example in the “Preserving class documentation comments” section of the README. Usinguser.rbhere as well helps avoid confusion and keeps the examples consistent throughout the documentation.