Add to_yard and to_rdoc methods to Annotation classes #302
Conversation
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
Fix NoMethodError when using YARD or RDoc format with indexes, foreign keys, or check constraints. The following Annotation classes were missing to_yard and to_rdoc methods that are called in annotation_builder.rb: - IndexAnnotation::Annotation - ForeignKeyAnnotation::Annotation - CheckConstraintAnnotation::Annotation Also adds unit tests for the new methods. Fixes drwl#212
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Fix
NoMethodError: undefined method 'to_yard'when using YARD or RDoc format options.Closes #212
Problem
When running
annotaterb models --format-yardon a model with indexes, foreign keys, or check constraints:NoMethodError: undefined method 'to_yard' for an instance of
AnnotateRb::ModelAnnotator::IndexAnnotation::Annotation
Solution
Added
to_yardandto_rdocmethods to:IndexAnnotation::AnnotationForeignKeyAnnotation::AnnotationCheckConstraintAnnotation::AnnotationRelated
CheckConstraintAnnotation)Test
to_yardandto_rdocin all three annotation specs