Add YARD documentation the PersonCard class #15614
Merged
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
We want to eventually document all classes in the app, so this is another step in that direction.
tmtmtmtm
suggested changes
Feb 23, 2017
lib/person_cards.rb
Outdated
| def identifiers | ||
| Section::Identifiers.new(person, top_identifiers: top_identifiers).data | ||
| end | ||
|
|
||
| # List of memberships this person holds in the current term |
There was a problem hiding this comment.
current is a little too ambiguous here, I fear.
The use of the word "current" was a bit misleading in this context, it could mean either the current page this class is being used on or the current term that's in session right now.
tmtmtmtm
approved these changes
Feb 23, 2017
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.
What does this do?
Adds YARD documentation to the
PersonCardclass.Why was this needed?
We want to document all the classes in this app as part of #15310.
More specifically I want to properly document the new methods I'm adding for cabinet memberships, so documenting the rest of this class first means I'm not changing the whole world at once when adding docs for that.
Relevant Issue(s)
Part of #15310
Should make #15606 easier to document…
Screenshots