Skip to content

Commit 812a92d

Browse files
docs: fix docstring formatting (#196)
* docs: fix docstring formatting Committer: @parthea PiperOrigin-RevId: 410919520 Source-Link: googleapis/googleapis@b5274f7 Source-Link: googleapis/googleapis-gen@a179eef Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYTE3OWVlZmIzYjMyODk3ZDc1YzUzZDgzNDlmMjM5MTBjNzc1MzA1MCJ9 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * remove replacements in owlbot.py * run owlbot cli locally Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
1 parent 6851470 commit 812a92d

File tree

4 files changed

+10
-27
lines changed

4 files changed

+10
-27
lines changed

packages/google-cloud-tasks/google/cloud/tasks_v2/types/target.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ class HttpRequest(proto.Message):
120120
[HttpRequest.url][google.cloud.tasks.v2.HttpRequest.url].
121121
- Content-Length: This will be computed by Cloud Tasks.
122122
- User-Agent: This will be set to ``"Google-Cloud-Tasks"``.
123-
- X-Google-\*: Google use only.
124-
- X-AppEngine-\*: Google use only.
123+
- ``X-Google-*``: Google use only.
124+
- ``X-AppEngine-*``: Google use only.
125125
126126
``Content-Type`` won't be set by Cloud Tasks. You can
127127
explicitly set ``Content-Type`` to a media type when the
@@ -303,8 +303,8 @@ class AppEngineHttpRequest(proto.Message):
303303
The headers below cannot be set or overridden:
304304
305305
- ``Host``
306-
- ``X-Google-\*``
307-
- ``X-AppEngine-\*``
306+
- ``X-Google-*``
307+
- ``X-AppEngine-*``
308308
309309
In addition, Cloud Tasks sets some headers when the task is
310310
dispatched, such as headers containing information about the

packages/google-cloud-tasks/google/cloud/tasks_v2beta2/types/target.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,8 +251,8 @@ class AppEngineHttpRequest(proto.Message):
251251
The headers below cannot be set or overridden:
252252
253253
- ``Host``
254-
- ``X-Google-\*``
255-
- ``X-AppEngine-\*``
254+
- ``X-Google-*``
255+
- ``X-AppEngine-*``
256256
257257
In addition, Cloud Tasks sets some headers when the task is
258258
dispatched, such as headers containing information about the

packages/google-cloud-tasks/google/cloud/tasks_v2beta3/types/target.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ class HttpRequest(proto.Message):
154154
[HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url].
155155
- Content-Length: This will be computed by Cloud Tasks.
156156
- User-Agent: This will be set to ``"Google-Cloud-Tasks"``.
157-
- X-Google-\*: Google use only.
158-
- X-AppEngine-\*: Google use only.
157+
- ``X-Google-*``: Google use only.
158+
- ``X-AppEngine-*``: Google use only.
159159
160160
``Content-Type`` won't be set by Cloud Tasks. You can
161161
explicitly set ``Content-Type`` to a media type when the
@@ -373,8 +373,8 @@ class AppEngineHttpRequest(proto.Message):
373373
The headers below cannot be set or overridden:
374374
375375
- ``Host``
376-
- ``X-Google-\*``
377-
- ``X-AppEngine-\*``
376+
- ``X-Google-*``
377+
- ``X-AppEngine-*``
378378
379379
In addition, Cloud Tasks sets some headers when the task is
380380
dispatched, such as headers containing information about the

packages/google-cloud-tasks/owlbot.py

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,6 @@
2626
default_version = "v2"
2727

2828
for library in s.get_staging_dirs(default_version):
29-
# Fix docstring.
30-
s.replace(library / "google/cloud/*/types/target.py", "X-Google-\*", "X-Google-\\*")
31-
s.replace(library / "google/cloud/*/types/target.py", "X-AppEngine-\*", "X-AppEngine-\\*")
32-
33-
# Comment out broken assertion in unit test
34-
# https://github.com/googleapis/gapic-generator-python/issues/897
35-
s.replace(
36-
library / "tests/**/test_cloud_tasks.py",
37-
"assert args\[0\]\.lease_duration == duration_pb2\.Duration\(seconds=751\)",
38-
"# assert args[0].lease_duration == duration_pb2.Duration(seconds=751)"
39-
)
40-
s.replace(
41-
library / "tests/**/test_cloud_tasks.py",
42-
"assert args\[0\].schedule_time == timestamp_pb2\.Timestamp\(seconds=751\)",
43-
"# assert args[0].schedule_time == timestamp_pb2.Timestamp(seconds=751)"
44-
)
45-
4629
excludes = ["README.rst", "setup.py", "nox*.py", "docs/index.rst", "*.tar.gz"]
4730
s.copy(library, excludes=excludes)
4831

0 commit comments

Comments
 (0)