Skip to content

chore(docs): adjust some docstrings #119

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
merged 1 commit into from
Oct 3, 2023
Merged

chore(docs): adjust some docstrings #119

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
8 changes: 4 additions & 4 deletions src/finch/resources/request_forwarding.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ def forward(
The Forward API allows you to make direct requests to an employment system.

Args:
method: The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
, `PUT` , `DELETE` , and `PATCH`.
method: The HTTP method for the forwarded request. Valid values include: `GET`, `POST`,
`PUT`, `DELETE`, and `PATCH`.

route: The URL route path for the forwarded request. This value must begin with a
forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and
Expand Down Expand Up @@ -97,8 +97,8 @@ async def forward(
The Forward API allows you to make direct requests to an employment system.

Args:
method: The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
, `PUT` , `DELETE` , and `PATCH`.
method: The HTTP method for the forwarded request. Valid values include: `GET`, `POST`,
`PUT`, `DELETE`, and `PATCH`.

route: The URL route path for the forwarded request. This value must begin with a
forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and
Expand Down
2 changes: 1 addition & 1 deletion src/finch/types/request_forwarding_forward_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class RequestForwardingForwardParams(TypedDict, total=False):
method: Required[str]
"""The HTTP method for the forwarded request.

Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.
Valid values include: `GET`, `POST`, `PUT`, `DELETE`, and `PATCH`.
"""

route: Required[str]
Expand Down