Cabinet memberships documentation #15616
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
chrismytton
force-pushed
the
cabinet-memberships-documentation
branch
from
ddf3c73 to
46db2b9
Compare
tmtmtmtm
suggested changes
Feb 28, 2017
lib/person_cards.rb
Outdated
| # @return [Array<EveryPolitician::Popolo::Membership>] | ||
| def memberships | ||
| def legislative_memberships |
There was a problem hiding this comment.
This doesn't look like it belongs here…
Have pulled that change into #15619 |
chrismytton
force-pushed
the
cabinet-memberships-documentation
branch
from
46db2b9 to
043a493
Compare
This documents the new (and currently unimplemented) `PersonCard#cabinet_memberships` method. This method will be used to return the cabinet memberships for the current person card.
These docs were originally put here when we thought we'd be adding some bits that would be more useful for external people. As it turns out we've ended up adding the logic to mostly internal classes for now, so we're documenting that in the classes themselves.
chrismytton
force-pushed
the
cabinet-memberships-documentation
branch
from
043a493 to
805a06a
Compare
|
Renaming |
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?
Updates the documentation for the cabinet memberships methods that was added in #15609 and moves it out of the README and into
lib/person_cards.rb.Why was this needed?
Originally we thought this code might be useful to outside people, as it was augmenting the everypolitician-ruby gem. Now though, we've decided that it's best for the functionality to live in some viewer-sinatra specific classes for now, until we have a better idea of how it all fits together at least. So this moves the docs to a more logical place.
Relevant Issue(s)
Extracted from #15615
Follows on from #15609
Replaces #15612
Part of #24
Implementation notes
This uses the YARD
@exampledocumentation tag, which render the example code out in the docs, see screenshot below.Screenshots
Notes to Reviewer
This is just the documentation for now, the implementation will come as a separate pull request.