Issue #142: Only one generator is documented#146
Merged
Conversation
nicoledow
commented
Jan 4, 2024
chawes13
reviewed
Jan 5, 2024
Contributor
chawes13
left a comment
chawes13
left a comment
There was a problem hiding this comment.
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 |
Contributor
There was a problem hiding this comment.
I don't think this is included automatically?
Contributor
Author
There was a problem hiding this comment.
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). |
Contributor
There was a problem hiding this comment.
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."
Contributor
Author
There was a problem hiding this comment.
Thanks for the link. Done!
chawes13
approved these changes
Jan 11, 2024
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
2 participants
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.
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.rbfollowing versioning guidelines