Skip to content

Commit 8cc031e

Browse files
docs: Minor formatting (#11543)
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 9be42e6 commit 8cc031e

File tree

171 files changed

+2080
-4769
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

171 files changed

+2080
-4769
lines changed

packages/google-cloud-artifact-registry/.flake8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# Copyright 2020 Google LLC
3+
# Copyright 2023 Google LLC
44
#
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.

packages/google-cloud-artifact-registry/CONTRIBUTING.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ We support:
236236

237237
Supported versions can be found in our ``noxfile.py`` `config`_.
238238

239-
.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
239+
.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-artifact-registry/noxfile.py
240240

241241

242242
**********

packages/google-cloud-artifact-registry/MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# Copyright 2020 Google LLC
3+
# Copyright 2023 Google LLC
44
#
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.

packages/google-cloud-artifact-registry/README.rst

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,24 @@ In order to use this library, you first need to go through the following steps:
3636
Installation
3737
~~~~~~~~~~~~
3838

39-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
40-
create isolated Python environments. The basic problem it addresses is one of
41-
dependencies and versions, and indirectly permissions.
39+
Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
40+
creates isolated Python environments. These isolated environments can have separate
41+
versions of Python packages, which allows you to isolate one project's dependencies
42+
from the dependencies of other projects.
4243

43-
With `virtualenv`_, it's possible to install this library without needing system
44+
With `venv`_, it's possible to install this library without needing system
4445
install permissions, and without clashing with the installed system
4546
dependencies.
4647

47-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
48+
.. _`venv`: https://docs.python.org/3/library/venv.html
4849

4950

5051
Code samples and snippets
5152
~~~~~~~~~~~~~~~~~~~~~~~~~
5253

53-
Code samples and snippets live in the `samples/` folder.
54+
Code samples and snippets live in the `samples/`_ folder.
55+
56+
.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-artifact-registry/samples
5457

5558

5659
Supported Python Versions
@@ -77,21 +80,19 @@ Mac/Linux
7780

7881
.. code-block:: console
7982
80-
pip install virtualenv
81-
virtualenv <your-env>
83+
python3 -m venv <your-env>
8284
source <your-env>/bin/activate
83-
<your-env>/bin/pip install google-cloud-artifact-registry
85+
pip install google-cloud-artifact-registry
8486
8587
8688
Windows
8789
^^^^^^^
8890

8991
.. code-block:: console
9092
91-
pip install virtualenv
92-
virtualenv <your-env>
93-
<your-env>\Scripts\activate
94-
<your-env>\Scripts\pip.exe install google-cloud-artifact-registry
93+
py -m venv <your-env>
94+
.\<your-env>\Scripts\activate
95+
pip install google-cloud-artifact-registry
9596
9697
Next Steps
9798
~~~~~~~~~~

packages/google-cloud-artifact-registry/docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# -*- coding: utf-8 -*-
2-
# Copyright 2021 Google LLC
2+
# Copyright 2023 Google LLC
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.

packages/google-cloud-artifact-registry/google/cloud/artifactregistry_v1/services/artifact_registry/async_client.py

Lines changed: 4 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -3430,42 +3430,11 @@ async def sample_set_iam_policy():
34303430
34313431
**JSON example:**
34323432
3433-
{
3434-
"bindings": [
3435-
{
3436-
"role":
3437-
"roles/resourcemanager.organizationAdmin",
3438-
"members": [ "user:mike@example.com",
3439-
"group:admins@example.com",
3440-
"domain:google.com",
3441-
"serviceAccount:my-project-id@appspot.gserviceaccount.com"
3442-
]
3443-
3444-
}, { "role":
3445-
"roles/resourcemanager.organizationViewer",
3446-
"members": [ "user:eve@example.com" ],
3447-
"condition": { "title": "expirable access",
3448-
"description": "Does not grant access after
3449-
Sep 2020", "expression": "request.time <
3450-
timestamp('2020-10-01T00:00:00.000Z')", } }
3451-
3452-
], "etag": "BwWWja0YfJA=", "version": 3
3453-
3454-
}
3433+
:literal:`\` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \`
34553434
34563435
**YAML example:**
34573436
3458-
bindings: - members: - user:\ mike@example.com -
3459-
group:\ admins@example.com - domain:google.com -
3460-
serviceAccount:\ my-project-id@appspot.gserviceaccount.com
3461-
role: roles/resourcemanager.organizationAdmin -
3462-
members: - user:\ eve@example.com role:
3463-
roles/resourcemanager.organizationViewer
3464-
condition: title: expirable access description:
3465-
Does not grant access after Sep 2020 expression:
3466-
request.time <
3467-
timestamp('2020-10-01T00:00:00.000Z') etag:
3468-
BwWWja0YfJA= version: 3
3437+
:literal:`\` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \`
34693438
34703439
For a description of IAM and its features, see the
34713440
[IAM
@@ -3572,42 +3541,11 @@ async def sample_get_iam_policy():
35723541
35733542
**JSON example:**
35743543
3575-
{
3576-
"bindings": [
3577-
{
3578-
"role":
3579-
"roles/resourcemanager.organizationAdmin",
3580-
"members": [ "user:mike@example.com",
3581-
"group:admins@example.com",
3582-
"domain:google.com",
3583-
"serviceAccount:my-project-id@appspot.gserviceaccount.com"
3584-
]
3585-
3586-
}, { "role":
3587-
"roles/resourcemanager.organizationViewer",
3588-
"members": [ "user:eve@example.com" ],
3589-
"condition": { "title": "expirable access",
3590-
"description": "Does not grant access after
3591-
Sep 2020", "expression": "request.time <
3592-
timestamp('2020-10-01T00:00:00.000Z')", } }
3593-
3594-
], "etag": "BwWWja0YfJA=", "version": 3
3595-
3596-
}
3544+
:literal:`\` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \`
35973545
35983546
**YAML example:**
35993547
3600-
bindings: - members: - user:\ mike@example.com -
3601-
group:\ admins@example.com - domain:google.com -
3602-
serviceAccount:\ my-project-id@appspot.gserviceaccount.com
3603-
role: roles/resourcemanager.organizationAdmin -
3604-
members: - user:\ eve@example.com role:
3605-
roles/resourcemanager.organizationViewer
3606-
condition: title: expirable access description:
3607-
Does not grant access after Sep 2020 expression:
3608-
request.time <
3609-
timestamp('2020-10-01T00:00:00.000Z') etag:
3610-
BwWWja0YfJA= version: 3
3548+
:literal:`\` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \`
36113549
36123550
For a description of IAM and its features, see the
36133551
[IAM

packages/google-cloud-artifact-registry/google/cloud/artifactregistry_v1/services/artifact_registry/client.py

Lines changed: 4 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -3903,42 +3903,11 @@ def sample_set_iam_policy():
39033903
39043904
**JSON example:**
39053905
3906-
{
3907-
"bindings": [
3908-
{
3909-
"role":
3910-
"roles/resourcemanager.organizationAdmin",
3911-
"members": [ "user:mike@example.com",
3912-
"group:admins@example.com",
3913-
"domain:google.com",
3914-
"serviceAccount:my-project-id@appspot.gserviceaccount.com"
3915-
]
3916-
3917-
}, { "role":
3918-
"roles/resourcemanager.organizationViewer",
3919-
"members": [ "user:eve@example.com" ],
3920-
"condition": { "title": "expirable access",
3921-
"description": "Does not grant access after
3922-
Sep 2020", "expression": "request.time <
3923-
timestamp('2020-10-01T00:00:00.000Z')", } }
3924-
3925-
], "etag": "BwWWja0YfJA=", "version": 3
3926-
3927-
}
3906+
:literal:`\` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \`
39283907
39293908
**YAML example:**
39303909
3931-
bindings: - members: - user:\ mike@example.com -
3932-
group:\ admins@example.com - domain:google.com -
3933-
serviceAccount:\ my-project-id@appspot.gserviceaccount.com
3934-
role: roles/resourcemanager.organizationAdmin -
3935-
members: - user:\ eve@example.com role:
3936-
roles/resourcemanager.organizationViewer
3937-
condition: title: expirable access description:
3938-
Does not grant access after Sep 2020 expression:
3939-
request.time <
3940-
timestamp('2020-10-01T00:00:00.000Z') etag:
3941-
BwWWja0YfJA= version: 3
3910+
:literal:`\` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \`
39423911
39433912
For a description of IAM and its features, see the
39443913
[IAM
@@ -4044,42 +4013,11 @@ def sample_get_iam_policy():
40444013
40454014
**JSON example:**
40464015
4047-
{
4048-
"bindings": [
4049-
{
4050-
"role":
4051-
"roles/resourcemanager.organizationAdmin",
4052-
"members": [ "user:mike@example.com",
4053-
"group:admins@example.com",
4054-
"domain:google.com",
4055-
"serviceAccount:my-project-id@appspot.gserviceaccount.com"
4056-
]
4057-
4058-
}, { "role":
4059-
"roles/resourcemanager.organizationViewer",
4060-
"members": [ "user:eve@example.com" ],
4061-
"condition": { "title": "expirable access",
4062-
"description": "Does not grant access after
4063-
Sep 2020", "expression": "request.time <
4064-
timestamp('2020-10-01T00:00:00.000Z')", } }
4065-
4066-
], "etag": "BwWWja0YfJA=", "version": 3
4067-
4068-
}
4016+
:literal:`\` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \`
40694017
40704018
**YAML example:**
40714019
4072-
bindings: - members: - user:\ mike@example.com -
4073-
group:\ admins@example.com - domain:google.com -
4074-
serviceAccount:\ my-project-id@appspot.gserviceaccount.com
4075-
role: roles/resourcemanager.organizationAdmin -
4076-
members: - user:\ eve@example.com role:
4077-
roles/resourcemanager.organizationViewer
4078-
condition: title: expirable access description:
4079-
Does not grant access after Sep 2020 expression:
4080-
request.time <
4081-
timestamp('2020-10-01T00:00:00.000Z') etag:
4082-
BwWWja0YfJA= version: 3
4020+
:literal:`\` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \`
40834021
40844022
For a description of IAM and its features, see the
40854023
[IAM

0 commit comments

Comments
 (0)