Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to reflect the {state: "all"} option #629

Merged
merged 2 commits into from Aug 12, 2015

Conversation

@nilbus
Copy link
Contributor

@nilbus nilbus commented Aug 7, 2015

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:

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>.

This comment has been minimized.

@pengwynn

pengwynn Aug 10, 2015
Collaborator

Oops, everything but number is existing copypasta. Mind removing :state, :sort, and `:direction here?

@@ -44,7 +44,7 @@ def milestone(repository, number, options = {})
# @param repository [String, Repository, Hash] A GitHub repository.
# @param title [String] A unique title.
# @param options [Hash] A customizable set of options.
# @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>.

This comment has been minimized.

@pengwynn

pengwynn Aug 10, 2015
Collaborator

The all value works for listings, but isn't a valid value for specifying state on a milestone.

@@ -61,7 +61,7 @@ def create_milestone(repository, title, options = {})
# @param number [String, Integer] ID of the milestone
# @param options [Hash] A customizable set of options.
# @option options [String] :title A unique title.
# @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>.

This comment has been minimized.

@pengwynn

pengwynn Aug 10, 2015
Collaborator

Same here, the all value works for listings, but isn't a valid value for specifying state on a milestone.

@pengwynn
Copy link
Collaborator

@pengwynn pengwynn commented Aug 10, 2015

Thanks @nilbus. I left a couple of comments.

@nilbus
Copy link
Contributor Author

@nilbus nilbus commented Aug 10, 2015

😵 good catch! Thank you for looking so closely. I will update this soon.

@nilbus
Copy link
Contributor Author

@nilbus nilbus commented Aug 12, 2015

Updated! This looks better to me now.

@pengwynn
Copy link
Collaborator

@pengwynn pengwynn commented Aug 12, 2015

🍰

pengwynn added a commit that referenced this pull request Aug 12, 2015
Update documentation to reflect the {state: "all"} option
@pengwynn pengwynn merged commit 46f1135 into octokit:master Aug 12, 2015
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.