Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix URLs #208

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.

Sign up for GitHub

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
brettcannon merged 1 commit into from
Jan 12, 2024
Merged

Fix URLs #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/__init__.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Exceptions
.. exception:: InvalidField(errors, *args)

Raised when a
`field in a request is invalid <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#client-errors>`_.
`field in a request is invalid <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api>`_.

Inherits from :exc:`BadRequest` and explicitly specifies a ``422`` status
code. Details of what fields were invalid are stored in the :attr:`errors`
Expand Down
9 changes: 4 additions & 5 deletions docs/abc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ experimental APIs without issue.
OAuth token and a cache object.

To allow for
`conditional requests <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#conditional-requests>`_,
`conditional requests <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api>`_,
one can provide a :class:`collections.abc.MutableMapping` object
for the *cache* argument to cache requests. It is up to the
caching object to provide any caching scheme that is desired
Expand Down Expand Up @@ -61,7 +61,7 @@ experimental APIs without issue.
.. versionchanged:: 2.0
Methods no longer automatically sleep when there is a chance
of exceeding the
`rate limit <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#rate-limiting>`_.
`rate limit <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api>`_.
This leads to :exc:`~gidgethub.RateLimitExceeded` being raised
when the rate limit has been execeeded.

Expand Down Expand Up @@ -113,8 +113,7 @@ experimental APIs without issue.

An abstract :term:`coroutine` which causes the coroutine to
sleep for the specified number of seconds. This is provided to
help prevent from going over one's
`rate limit <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#rate-limiting>`_.
help prevent from going over one's `rate limit`_.

.. versionchanged:: 2.0

Expand Down Expand Up @@ -171,7 +170,7 @@ experimental APIs without issue.

An asynchronous iterable is returned which will yield all items
from the endpoint (i.e. use ``async for`` on the result). Any
`pagination <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#pagination>`_
`pagination <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api>`_
will automatically be followed.

*jwt* is the value of the JSON web token, for authenticating as a GitHub
Expand Down
8 changes: 4 additions & 4 deletions docs/sansio.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ without requiring the use of the :class:`Event` class.

.. function:: validate_event(payload, *, signature, secret)

`Validate the signature <https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/securing-your-webhooks#validating-payloads-from-github>`_
`Validate the signature <https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/securing-your-webhooks>`_
of a webhook event.

:exc:`~gidgethub.ValidationFailure` is raised if the signature is malformed
Expand Down Expand Up @@ -127,7 +127,7 @@ by helping to automate the GitHub-specific aspects of a REST call.
Create a dict representing GitHub-specific header fields.

The user agent is set according to who the *requester* is.
`GitHub asks <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#user-agent-required>`_ it be
`GitHub asks <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api>`_ it be
either a username or project name.

The *accept* argument corresponds to the ``'accept'`` field and defaults to
Expand All @@ -137,7 +137,7 @@ by helping to automate the GitHub-specific aspects of a REST call.
response, e.g. wanting the rendered HTML of a Markdown file.

The *oauth_token* allows making an
`authenticated request <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#authentication>`_.
`authenticated request <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api>`_.
This can be important if you need the expanded rate limit provided by an
authenticated request.

Expand Down Expand Up @@ -179,7 +179,7 @@ that are provided to you. Continuing from the example in the Requests_ section::

.. class:: RateLimit(*, limit, remaining, reset_epoch)

The `rate limit <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#rate-limiting>`_ imposed
The `rate limit <https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api>`_ imposed
upon the requester.

The *reset_epoch* argument is expected to be UTC seconds from the epoch.
Expand Down