Closed ChaelCodes closed 3 years ago
Is your feature request related to a problem? Please describe. Annotate offers Yard formatting, and we want to use that to format our documentation.
Additional context We automatically generate documentation using inline documentation and share them at https://rubydoc.info/github/ChaelCodes/HuntersKeepers/Hunter.
Solution https://github.com/ChaelCodes/HuntersKeepers/blob/d611c8e62e4bd64dd94e0f4e650481bcd4915310/lib/tasks/auto_annotate_models.rake#L47-L49
Turn off format_bare and turn on format_yard, then run rake db:migrate to update the annotate docs in each class.
format_bare
format_yard
rake db:migrate
References Any references to materials or help articles that may help in implementing this issue.
Describe the Feature
Is your feature request related to a problem? Please describe. Annotate offers Yard formatting, and we want to use that to format our documentation.
Additional context We automatically generate documentation using inline documentation and share them at https://rubydoc.info/github/ChaelCodes/HuntersKeepers/Hunter.
Describe the Technical Implementation of the Solution
Solution https://github.com/ChaelCodes/HuntersKeepers/blob/d611c8e62e4bd64dd94e0f4e650481bcd4915310/lib/tasks/auto_annotate_models.rake#L47-L49
Turn off
format_bareand turn onformat_yard, then runrake db:migrateto update the annotate docs in each class.References Any references to materials or help articles that may help in implementing this issue.