Data completeness subview class #15432
Open
Conversation
This file contains 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
|
Yardoc is complaining about: |
| # The completeness of each type of member data as a percentage | ||
| class DataCompleteness | ||
| # @param [Array PersonCard] | ||
| def initialize(people:) |
There was a problem hiding this comment.
If this is receiving an array of PersonCard, perhaps better to call this something like person_cards. people would imply to me that it's wanting Person objects instead.
New name reflects that value is array of person cards.
New name reflects that completeness() is a query method
|
@ondenman You haven't fixed the problem yet that yardoc is complaining about at line 5 (i.e. you haven't documented what the variable is called — only its type) |
| end | ||
|
|
||
| CARDS = %i(social bio contacts identifiers).freeze | ||
| Percentages = Struct.new(*CARDS) |
There was a problem hiding this comment.
This Percentages class isn't documented…
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added class to provide data for data completeness subview:
Extracted from
TermTable#percentages