Skip to content

Mention search api in docs under Issues find() #302

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

Merged
merged 5 commits into from
Aug 6, 2015

Conversation

emersonthis
Copy link
Contributor

No description provided.

@@ -23,7 +23,7 @@ Returns an array of issues.
$issues = $client->api('issue')->find('KnpLabs', 'php-github-api', 'closed', 'bug');
```

Returns an array of closed issues matching the "bug" term.
Returns an array of closed issues matching the "bug" term. For more complex searches, use the [search api](/doc/search.md) which supports the advanced github search syntax.
Copy link
Contributor

Choose a reason for hiding this comment

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

please use relative links. It will be more reliable if the way to diplay the doc changes

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Did I add an absolute URL somewhere?

On Aug 5, 2015, at 9:48 AM, Christophe Coevoet notifications@github.com wrote:

In doc/issues.md:

@@ -23,7 +23,7 @@ Returns an array of issues.
$issues = $client->api('issue')->find('KnpLabs', 'php-github-api', 'closed', 'bug');


-Returns an array of closed issues matching the "bug" term.
+Returns an array of closed issues matching the "bug" term. For more complex searches, use the [search api](/doc/search.md) which supports the advanced github search syntax.
please use relative links. It will be more reliable if the way to diplay the doc changes


Reply to this email directly or view it on GitHub.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@stof Oh I see what you're talking about. I'll fix it.

@@ -23,7 +23,7 @@ Returns an array of issues.
$issues = $client->api('issue')->find('KnpLabs', 'php-github-api', 'closed', 'bug');
```

Returns an array of closed issues matching the "bug" term.
Returns an array of closed issues matching the "bug" term. For more complex searches, use the [search api](search.md) which supports the advanced github search syntax.
Copy link
Contributor

Choose a reason for hiding this comment

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

should be written GitHub imo

@emersonthis
Copy link
Contributor Author

@xabbuh done

cursedcoder added a commit that referenced this pull request Aug 6, 2015
Mention search api in docs under Issues find()
@cursedcoder cursedcoder merged commit c9aa4cf into KnpLabs:master Aug 6, 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.

4 participants