Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

Commit

Permalink
docs: fix docstring formatting (#135)
Browse files Browse the repository at this point in the history 
* docs: fix docstring formatting

Committer: @parthea
PiperOrigin-RevId: 407854413

Source-Link: googleapis/googleapis@f81b7bd

Source-Link: googleapis/googleapis-gen@1f0cfde
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMWYwY2ZkZTU1MTRmYWUwMjRjNjczYjY3OTgxNzRhYjY3MjdjYjBhNSJ9

* 🦉 Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Nov 5, 2021
1 parent 0d38221 commit c703958
Show file tree
Hide file tree
Showing 9 changed files with 84 additions and 68 deletions.
12 changes: 7 additions & 5 deletions google/cloud/resourcemanager_v3/services/folders/async_client.py
View file
Expand Up @@ -376,11 +376,13 @@ async def search_folders(
use escaped quotes for values that include whitespace to
prevent unexpected behavior.
\| Field \| Description \|
\|-------------------------\|----------------------------------------\|
\| displayName \| Filters by displayName. \| \| parent
\| Filters by parent (for example: folders/123). \| \|
state, lifecycleState \| Filters by state. \|
::
| Field | Description |
|-------------------------\|----------------------------------------|
| displayName | Filters by displayName. |
| parent | Filters by parent (for example: folders/123). |
| state, lifecycleState | Filters by state. |
Some example queries are:
Expand Down
12 changes: 7 additions & 5 deletions google/cloud/resourcemanager_v3/services/folders/client.py
View file
Expand Up @@ -545,11 +545,13 @@ def search_folders(
use escaped quotes for values that include whitespace to
prevent unexpected behavior.
\| Field \| Description \|
\|-------------------------\|----------------------------------------\|
\| displayName \| Filters by displayName. \| \| parent
\| Filters by parent (for example: folders/123). \| \|
state, lifecycleState \| Filters by state. \|
::
| Field | Description |
|-------------------------\|----------------------------------------|
| displayName | Filters by displayName. |
| parent | Filters by parent (for example: folders/123). |
| state, lifecycleState | Filters by state. |
Some example queries are:
Expand Down
12 changes: 7 additions & 5 deletions google/cloud/resourcemanager_v3/services/organizations/async_client.py
View file
Expand Up @@ -279,11 +279,13 @@ async def search_organizations(
Organizations to return in the response. Query rules are
case-insensitive.
\| Field \| Description \|
\|------------------\|--------------------------------------------\|
\| directoryCustomerId, owner.directoryCustomerId \|
Filters by directory customer id. \| \| domain \|
Filters by domain. \|
::
| Field | Description |
|------------------\|--------------------------------------------|
| directoryCustomerId, owner.directoryCustomerId | Filters by directory
customer id. |
| domain | Filters by domain. |
Organizations may be queried by ``directoryCustomerId``
or by ``domain``, where the domain is a G Suite domain,
Expand Down
12 changes: 7 additions & 5 deletions google/cloud/resourcemanager_v3/services/organizations/client.py
View file
Expand Up @@ -449,11 +449,13 @@ def search_organizations(
Organizations to return in the response. Query rules are
case-insensitive.
\| Field \| Description \|
\|------------------\|--------------------------------------------\|
\| directoryCustomerId, owner.directoryCustomerId \|
Filters by directory customer id. \| \| domain \|
Filters by domain. \|
::
| Field | Description |
|------------------\|--------------------------------------------|
| directoryCustomerId, owner.directoryCustomerId | Filters by directory
customer id. |
| domain | Filters by domain. |
Organizations may be queried by ``directoryCustomerId``
or by ``domain``, where the domain is a G Suite domain,
Expand Down
27 changes: 14 additions & 13 deletions google/cloud/resourcemanager_v3/services/projects/async_client.py
View file
Expand Up @@ -384,19 +384,20 @@ async def search_projects(
query, the it will return results that match any of the
fields. Some eligible fields are:
\| Field \| Description \|
\|-------------------------\|----------------------------------------------\|
\| displayName, name \| Filters by displayName. \| \|
parent \| Project's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type
and parent.id. \| \| parent.type \| Parent's type:
``folder`` or ``organization``. \| \| parent.id \|
Parent's id number (for example: 123) \| \| id,
projectId \| Filters by projectId. \| \| state,
lifecycleState \| Filters by state. \| \| labels \|
Filters by label name or value. \| \| labels. (where
*key* is the name of a label) \| Filters by label name.
\|
::
| Field | Description |
|-------------------------\|----------------------------------------------|
| displayName, name | Filters by displayName. |
| parent | Project's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and parent.id. |
| parent.type | Parent's type: `folder` or `organization`. |
| parent.id | Parent's id number (for example: 123) |
| id, projectId | Filters by projectId. |
| state, lifecycleState | Filters by state. |
| labels | Filters by label name or value. |
| labels.<key> (where *key* is the name of a label) | Filters by label
name. |
Search expressions are case insensitive.
Expand Down
27 changes: 14 additions & 13 deletions google/cloud/resourcemanager_v3/services/projects/client.py
View file
Expand Up @@ -553,19 +553,20 @@ def search_projects(
query, the it will return results that match any of the
fields. Some eligible fields are:
\| Field \| Description \|
\|-------------------------\|----------------------------------------------\|
\| displayName, name \| Filters by displayName. \| \|
parent \| Project's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type
and parent.id. \| \| parent.type \| Parent's type:
``folder`` or ``organization``. \| \| parent.id \|
Parent's id number (for example: 123) \| \| id,
projectId \| Filters by projectId. \| \| state,
lifecycleState \| Filters by state. \| \| labels \|
Filters by label name or value. \| \| labels. (where
*key* is the name of a label) \| Filters by label name.
\|
::
| Field | Description |
|-------------------------\|----------------------------------------------|
| displayName, name | Filters by displayName. |
| parent | Project's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and parent.id. |
| parent.type | Parent's type: `folder` or `organization`. |
| parent.id | Parent's id number (for example: 123) |
| id, projectId | Filters by projectId. |
| state, lifecycleState | Filters by state. |
| labels | Filters by label name or value. |
| labels.<key> (where *key* is the name of a label) | Filters by label
name. |
Search expressions are case insensitive.
Expand Down
12 changes: 7 additions & 5 deletions google/cloud/resourcemanager_v3/types/folders.py
View file
Expand Up @@ -193,11 +193,13 @@ class SearchFoldersRequest(proto.Message):
escaped quotes for values that include whitespace to prevent
unexpected behavior.
\| Field \| Description \|
\|-------------------------\|----------------------------------------\|
\| displayName \| Filters by displayName. \| \| parent \|
Filters by parent (for example: folders/123). \| \| state,
lifecycleState \| Filters by state. \|
::
| Field | Description |
|-------------------------\|----------------------------------------|
| displayName | Filters by displayName. |
| parent | Filters by parent (for example: folders/123). |
| state, lifecycleState | Filters by state. |
Some example queries are:
Expand Down
12 changes: 7 additions & 5 deletions google/cloud/resourcemanager_v3/types/organizations.py
View file
Expand Up @@ -124,11 +124,13 @@ class SearchOrganizationsRequest(proto.Message):
Organizations to return in the response. Query rules are
case-insensitive.
\| Field \| Description \|
\|------------------\|--------------------------------------------\|
\| directoryCustomerId, owner.directoryCustomerId \| Filters
by directory customer id. \| \| domain \| Filters by domain.
\|
::
| Field | Description |
|------------------\|--------------------------------------------|
| directoryCustomerId, owner.directoryCustomerId | Filters by directory
customer id. |
| domain | Filters by domain. |
Organizations may be queried by ``directoryCustomerId`` or
by ``domain``, where the domain is a G Suite domain, for
Expand Down
26 changes: 14 additions & 12 deletions google/cloud/resourcemanager_v3/types/projects.py
View file
Expand Up @@ -227,18 +227,20 @@ class SearchProjectsRequest(proto.Message):
return results that match any of the fields. Some eligible
fields are:
\| Field \| Description \|
\|-------------------------\|----------------------------------------------\|
\| displayName, name \| Filters by displayName. \| \| parent
\| Project's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and
parent.id. \| \| parent.type \| Parent's type: ``folder`` or
``organization``. \| \| parent.id \| Parent's id number (for
example: 123) \| \| id, projectId \| Filters by projectId.
\| \| state, lifecycleState \| Filters by state. \| \|
labels \| Filters by label name or value. \| \| labels.
(where *key* is the name of a label) \| Filters by label
name. \|
::
| Field | Description |
|-------------------------\|----------------------------------------------|
| displayName, name | Filters by displayName. |
| parent | Project's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and parent.id. |
| parent.type | Parent's type: `folder` or `organization`. |
| parent.id | Parent's id number (for example: 123) |
| id, projectId | Filters by projectId. |
| state, lifecycleState | Filters by state. |
| labels | Filters by label name or value. |
| labels.<key> (where *key* is the name of a label) | Filters by label
name. |
Search expressions are case insensitive.
Expand Down

0 comments on commit c703958

Please sign in to comment.