Update documentation to reflect the {state: "all"} option #629
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
This applies to both issues and milestones where the default state is "open". Although undocumented, the "all" option is confirmed to work. See the API docs: * https://developer.github.com/v3/issues/#parameters-1 * https://developer.github.com/v3/issues/milestones/#parameters
| @@ -28,7 +28,7 @@ def list_milestones(repository, options = {}) | |||
| # @param repository [String, Repository, Hash] A GitHub repository. | |||
| # @param options [Hash] A customizable set of options. | |||
| # @option options [Integer] :milestone Milestone number. | |||
| # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>. | |||
| # @option options [String] :state (open) State: <tt>open</tt>, <tt>closed</tt>, or <tt>all</tt>. | |||
There was a problem hiding this comment.
Oops, everything but number is existing copypasta. Mind removing :state, :sort, and `:direction here?
|
Thanks @nilbus. I left a couple of comments. |
|
😵 good catch! Thank you for looking so closely. I will update this soon. |
|
Updated! This looks better to me now. |
|
🍰 |
pengwynn
added a commit
that referenced
this pull request
Aug 12, 2015
Update documentation to reflect the {state: "all"} option
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.
This applies to both issues and milestones where the default state is "open".
Although undocumented, the "all" option is confirmed to work.
See the API docs: