-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Issue #142: Only one generator is documented #146
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm generally in favor of every commit to main == new release, even if it's just documentation. Can you increment the patch version?
README.md
Outdated
|
||
# Creates app/decanters/trip_decanter.rb: | ||
class TripDecanter < Decanter::Base | ||
input :id, :integer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is included automatically?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You mean the id
parser, right? You're correct - removed from this example as well as the other ✔️
README.md
Outdated
end | ||
``` | ||
|
||
See more details on using custom parsers [here](#custom-parsers). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not a huge fan of "here" links (https://granicus.com/blog/why-click-here-links-are-bad/ has some general rationale). An alternative could be something like, "Learn more about using custom parsers."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the link. Done!
Items Addressed
#142
Review Questions
For both this PR and #145, I did not update the version number. I wasn't sure if ReadME updates warrant a new version?
Author Checklist
version.rb
following versioning guidelines