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

Add document for query of search functions #1300

Merged
merged 2 commits into from Oct 6, 2019

Conversation

iamquang95
Copy link
Contributor

Addressed the document part of #1266

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@iamquang95
Copy link
Contributor Author

@googlebot I signed it!

@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: yes Indication that the PR author has signed a Google Contributor License Agreement. and removed cla: no labels Oct 5, 2019
@codecov
Copy link

codecov bot commented Oct 5, 2019

Codecov Report

Merging #1300 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1300   +/-   ##
=======================================
  Coverage   73.42%   73.42%           
=======================================
  Files          86       86           
  Lines        6047     6047           
=======================================
  Hits         4440     4440           
  Misses        837      837           
  Partials      770      770
Impacted Files Coverage Δ
github/search.go 92.15% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a01ea50...8c0467f. Read the comment docs.

github/search.go Outdated
@@ -24,6 +24,10 @@ import (
// will search for such issues, sorting by creation date in ascending order
// (i.e., oldest first).
//
// If query includes multiple condition, it MUST NOT include "+" as condition separator.
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: Could you please tweak this slightly so that it is easier to read? How about:

// If query includes multiple conditions, it MUST NOT include "+" as the condition separator.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, i will add more detail (using " " instead) to the documentation. Thanks for your review.

Copy link
Collaborator

@gmlewis gmlewis left a comment

Choose a reason for hiding this comment

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

Thank you, @iamquang95!
LGTM.
Merging.

@gmlewis gmlewis merged commit 740806a into google:master Oct 6, 2019
@iamquang95 iamquang95 deleted the add-doc-search branch October 13, 2019 04:36
@gmlewis
Copy link
Collaborator

gmlewis commented Dec 5, 2019

Closes #1266.

n1lesh pushed a commit to n1lesh/go-github that referenced this pull request Oct 2, 2020
* Add document for search query

* Add more detail of using search query
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Indication that the PR author has signed a Google Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants