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

Add high-level docs for the Ruby gem #72

Open
composerinteralia opened this issue May 4, 2023 · 1 comment
Open

Add high-level docs for the Ruby gem #72

composerinteralia opened this issue May 4, 2023 · 1 comment

Comments

@composerinteralia
Copy link
Contributor

#71 was a good reminder that the gem does a whole bunch of things that currently have little or no documentation. With Trilogy soon to be an officially supported option for Rails, now is a good time to add some better documentation (expanding what we have in https://github.com/github/trilogy/blob/7ceee303b7d440f0b26cba65d00032bfb897c0ef/contrib/ruby/README.md would be a good place to start).

@bensheldon
Copy link
Contributor

Some things that we likely want to document, either through example or reasonable reference (i.e. anything that is Trilogy-specific, or database options/flags that are translated into Ruby-style; we shouldn't duplicately list every database options/flag that are documented elsewhere):

  • Trilogy.new arguments
  • Trilogy instance methods (the practical example already in the readme is a good starting place)
  • Usage of Trilogy::Result
  • Error classes and their general meaning

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

No branches or pull requests

2 participants