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.

Sign up for GitHub

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

Jump to bottom

Document public API for DatabaseCleaner::Configuration #631

Open

etagwerker opened this issue Mar 11, 2020 · 0 comments

Labels

first-timers-only good first issue

Member

etagwerker commented Mar 11, 2020 •

edited

Loading

Hi there,

I think this can be a good issue for a first-time contributor. It would be great if we can increase documentation for the DatabaseCleaner::Configuration API: https://github.com/DatabaseCleaner/database_cleaner/blob/master/lib/database_cleaner/configuration.rb#L56-L72

Even though methods are pretty self-explanatory, I think it is a good idea to maintain a complete documentation for public methods. If you look at https://rubydoc.info/gems/database_cleaner/DatabaseCleaner/Configuration you will find some TODO comments but not much more than that.

In order to follow the standard defined by YARD, method documentation should follow this guide: https://rubydoc.info/gems/yard/file/docs/GettingStarted.md

If you think this is a good idea, we can create more issues for other classes that are poorly documented.

Best,
Ernesto

etagwerker added first-timers-only good first issue labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment