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

docs: Fix formatting of request arg in docstring #308

Merged
merged 2 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 4 additions & 7 deletions google/cloud/trace_v1/services/trace_service/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -255,9 +255,8 @@ async def sample_list_traces():

Args:
request (Optional[Union[google.cloud.trace_v1.types.ListTracesRequest, dict]]):
The request object. The request message for the
`ListTraces` method. All fields are required unless
specified.
The request object. The request message for the ``ListTraces`` method. All
fields are required unless specified.
project_id (:class:`str`):
Required. ID of the Cloud project
where the trace data is stored.
Expand Down Expand Up @@ -383,8 +382,7 @@ async def sample_get_trace():

Args:
request (Optional[Union[google.cloud.trace_v1.types.GetTraceRequest, dict]]):
The request object. The request message for the
`GetTrace` method.
The request object. The request message for the ``GetTrace`` method.
project_id (:class:`str`):
Required. ID of the Cloud project
where the trace data is stored.
Expand Down Expand Up @@ -514,8 +512,7 @@ async def sample_patch_traces():

Args:
request (Optional[Union[google.cloud.trace_v1.types.PatchTracesRequest, dict]]):
The request object. The request message for the
`PatchTraces` method.
The request object. The request message for the ``PatchTraces`` method.
project_id (:class:`str`):
Required. ID of the Cloud project
where the trace data is stored.
Expand Down
11 changes: 4 additions & 7 deletions google/cloud/trace_v1/services/trace_service/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -466,9 +466,8 @@ def sample_list_traces():

Args:
request (Union[google.cloud.trace_v1.types.ListTracesRequest, dict]):
The request object. The request message for the
`ListTraces` method. All fields are required unless
specified.
The request object. The request message for the ``ListTraces`` method. All
fields are required unless specified.
project_id (str):
Required. ID of the Cloud project
where the trace data is stored.
Expand Down Expand Up @@ -584,8 +583,7 @@ def sample_get_trace():

Args:
request (Union[google.cloud.trace_v1.types.GetTraceRequest, dict]):
The request object. The request message for the
`GetTrace` method.
The request object. The request message for the ``GetTrace`` method.
project_id (str):
Required. ID of the Cloud project
where the trace data is stored.
Expand Down Expand Up @@ -705,8 +703,7 @@ def sample_patch_traces():

Args:
request (Union[google.cloud.trace_v1.types.PatchTracesRequest, dict]):
The request object. The request message for the
`PatchTraces` method.
The request object. The request message for the ``PatchTraces`` method.
project_id (str):
Required. ID of the Cloud project
where the trace data is stored.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,6 @@ def __call__(
request (~.trace.ListTracesRequest):
The request object. The request message for the ``ListTraces`` method. All
fields are required unless specified.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
21 changes: 11 additions & 10 deletions google/cloud/trace_v2/services/trace_service/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,8 +263,7 @@ async def sample_batch_write_spans():

Args:
request (Optional[Union[google.cloud.trace_v2.types.BatchWriteSpansRequest, dict]]):
The request object. The request message for the
`BatchWriteSpans` method.
The request object. The request message for the ``BatchWriteSpans`` method.
name (:class:`str`):
Required. The name of the project where the spans
belong. The format is ``projects/[PROJECT_ID]``.
Expand Down Expand Up @@ -378,14 +377,16 @@ async def sample_create_span():
Args:
request (Optional[Union[google.cloud.trace_v2.types.Span, dict]]):
The request object. A span represents a single operation
within a trace. Spans can be nested to form a trace
tree. Often, a trace contains a root span that describes
the end-to-end latency, and one or more subspans for its
sub-operations.

A trace can also contain multiple root spans, or none at
all. Spans do not need to be contiguous. There might be
gaps or overlaps between spans in a trace.
within a trace. Spans can be nested to
form a trace tree. Often, a trace
contains a root span that describes the
end-to-end latency, and one or more
subspans for its sub-operations.

A trace can also contain multiple root
spans, or none at all. Spans do not need
to be contiguous. There might be gaps or
overlaps between spans in a trace.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
21 changes: 11 additions & 10 deletions google/cloud/trace_v2/services/trace_service/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -494,8 +494,7 @@ def sample_batch_write_spans():

Args:
request (Union[google.cloud.trace_v2.types.BatchWriteSpansRequest, dict]):
The request object. The request message for the
`BatchWriteSpans` method.
The request object. The request message for the ``BatchWriteSpans`` method.
name (str):
Required. The name of the project where the spans
belong. The format is ``projects/[PROJECT_ID]``.
Expand Down Expand Up @@ -599,14 +598,16 @@ def sample_create_span():
Args:
request (Union[google.cloud.trace_v2.types.Span, dict]):
The request object. A span represents a single operation
within a trace. Spans can be nested to form a trace
tree. Often, a trace contains a root span that describes
the end-to-end latency, and one or more subspans for its
sub-operations.

A trace can also contain multiple root spans, or none at
all. Spans do not need to be contiguous. There might be
gaps or overlaps between spans in a trace.
within a trace. Spans can be nested to
form a trace tree. Often, a trace
contains a root span that describes the
end-to-end latency, and one or more
subspans for its sub-operations.

A trace can also contain multiple root
spans, or none at all. Spans do not need
to be contiguous. There might be gaps or
overlaps between spans in a trace.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,6 @@ def __call__(
spans, or none at all. Spans do not need
to be contiguous. There might be gaps or
overlaps between spans in a trace.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-trace",
"version": "1.11.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-trace",
"version": "1.11.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down