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>.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@pengwynn
Copy link
Collaborator

Thanks @nilbus. I left a couple of comments.

@nilbus
Copy link
Contributor Author

nilbus commented Aug 10, 2015

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

@nilbus
Copy link
Contributor Author

nilbus commented Aug 12, 2015

Updated! This looks better to me now.

@pengwynn
Copy link
Collaborator

🍰

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants