Skip to content
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

Merged
merged 9 commits into from
Jan 11, 2024

Conversation

nicoledow
Copy link
Contributor

@nicoledow nicoledow commented Jan 2, 2024

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

  • Add unit test(s)
  • Update documentation (if necessary)
  • Update version in version.rb following versioning guidelines

@nicoledow nicoledow linked an issue Jan 2, 2024 that may be closed by this pull request
README.md Show resolved Hide resolved
@nicoledow nicoledow marked this pull request as ready for review January 4, 2024 21:39
Copy link
Contributor

@chawes13 chawes13 left a 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
Copy link
Contributor

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?

Copy link
Contributor Author

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

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."

Copy link
Contributor Author

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!

README.md Show resolved Hide resolved
@chawes13 chawes13 merged commit 5234600 into main Jan 11, 2024
2 checks passed
@chawes13 chawes13 deleted the 142-only-one-generator-is-documented branch January 11, 2024 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Only one generator is documented
2 participants