Skip to content

Commit 90fabd9

Browse files
fix: many small corrections in docs
Thanks @dimaqq Co-authored-by: Dima Tisnek <[email protected]>
1 parent ecaac22 commit 90fabd9

8 files changed

+12
-13
lines changed

docs/howto/manage-applications.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -176,14 +176,14 @@ Manage constraints for an application
176176

177177
.. code:: python
178178
179-
await my_model.deploy(..., constraints={, 'arch': 'amd64', 'mem': 256}, ...)
179+
await my_model.deploy(..., constraints={'arch': 'amd64', 'mem': 256}, ...)
180180
181181
182182
* To set constraints post deployment, you may use the `Application.set_contraints()` method, similar to passing constraints in the deploy call above:
183183

184184
.. code:: python
185185
186-
await my_app.set_constraints(constraints={, 'arch': 'amd64', 'mem': 256})
186+
await my_app.set_constraints(constraints={'arch': 'amd64', 'mem': 256})
187187
188188
189189
**Get values.** To see what constraints are set on an application, use the `Application.get_constraints()` method:

docs/howto/manage-credentials.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ To update a credential, on a connected `Controller` object, use the `Controller.
1616
from juju.client import client as jujuclient
1717
1818
my_controller.add_credential("my-credential",
19-
jujuclient.CloudCredential(auth_type="jsonfile", attrs={'file':'path_to_cred_file'})
19+
jujuclient.CloudCredential(auth_type="jsonfile", attrs={'file':'path_to_cred_file'}))
2020
2121
> See more: `add_credential (method) <https://pythonlibjuju.readthedocs.io/en/latest/api/juju.controller.html#juju.controller.Controller.add_credential>`_

docs/howto/manage-secret-backends.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To add a secret backend to a controller, on a connected Controller, use the `add
1818
1919
await my_controller.add_secret_backends("1001", "myvault", "vault", {"endpoint": vault_url, "token": keys["root_token"]})
2020
21-
> See more: `add_secret_backend() <https://pythonlibjuju.readthedocs.io/en/latest/api/juju.controller.html#juju.controller.Controller.add_secret_backends>`_, `Controller (module) <https://pythonlibjuju.readthedocs.io/en/latest/narrative/controller.html>`_
21+
> See more: `add_secret_backends() <https://pythonlibjuju.readthedocs.io/en/latest/api/juju.controller.html#juju.controller.Controller.add_secret_backends>`_, `Controller (module) <https://pythonlibjuju.readthedocs.io/en/latest/narrative/controller.html>`_
2222

2323

2424
View all the secret backends available on a controller
@@ -46,7 +46,7 @@ To update a secret backend on the controller, on a connected Controller, use the
4646
4747
Check out the documentation for the full list of arguments.
4848

49-
> See more: `update_secret_backend() <https://pythonlibjuju.readthedocs.io/en/latest/api/juju.controller.html#juju.controller.Controller.update_secret_backends>`_, `Controller (module) <https://pythonlibjuju.readthedocs.io/en/latest/narrative/controller.html>`_
49+
> See more: `update_secret_backends() <https://pythonlibjuju.readthedocs.io/en/latest/api/juju.controller.html#juju.controller.Controller.update_secret_backends>`_, `Controller (module) <https://pythonlibjuju.readthedocs.io/en/latest/narrative/controller.html>`_
5050

5151
Remove a secret backend
5252
-----------------------

docs/howto/manage-ssh-keys.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To add a public `ssh` key to a model, on a connected Model object, use the `add_
1717
await my_model.add_ssh_key('admin', SSH_KEY)
1818
1919
20-
> See more: `add_ssh_key() `https://pythonlibjuju.readthedocs.io/en/latest/api/juju.model.html#juju.model.Model.add_ssh_key>`_, `Model (module) <https://pythonlibjuju.readthedocs.io/en/latest/narrative/model.html>`_
20+
> See more: `add_ssh_key() https://pythonlibjuju.readthedocs.io/en/latest/api/juju.model.html#juju.model.Model.add_ssh_key>`_, `Model (module) <https://pythonlibjuju.readthedocs.io/en/latest/narrative/model.html>`_
2121

2222

2323
View the available SSH keys

docs/howto/manage-storage-pools.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To update an existing storage pool attributes, on a connected Model object, use
3838
3939
await my_model.update_storage_pool(
4040
"operator-storage",
41-
attributes={"volume-type":"provisioned-iops", "iops"="40"})
41+
attributes={"volume-type": "provisioned-iops", "iops": "40"})
4242
4343
> See more: `update_storage_pool() <https://pythonlibjuju.readthedocs.io/en/latest/api/juju.model.html#juju.model.Model.update_storage_pool>`_, `Model (module) <https://pythonlibjuju.readthedocs.io/en/latest/narrative/model.html>`_
4444

docs/howto/manage-storage.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,7 @@ To detach a storage instance from a unit, on a Unit object, use the `detach_stor
5050
5151
await my_unit.detach_storage("osd-devices/2")
5252
53-
54-
> See more: `detach_storage() <https://pythonlibjuju.readthedocs.io/en/latest/api/juju.unit.html#juju.unit.Unit.detach_storage>`_, `Unit (module) <https://pythonlibjuju.readthedocs.io/en/latest/narrative/unit.html)>`_
53+
> See more: `detach_storage() <https://pythonlibjuju.readthedocs.io/en/latest/api/juju.unit.html#juju.unit.Unit.detach_storage>`_, `Unit (module) <https://pythonlibjuju.readthedocs.io/en/latest/narrative/unit.html>`_
5554

5655

5756
Attach storage

docs/howto/manage-units.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ If you're on an IAAS system (machine applications):
4646
Show details about a unit
4747
-------------------------
4848

49-
Too see details about a unit in `python-libjuju` client, you can use various fields and methods of a `Unit` object. For example, to get the `public_address` of a unit:
49+
To see details about a unit in `python-libjuju` client, you can use various fields and methods of a `Unit` object. For example, to get the `public_address` of a unit:
5050

5151
.. code:: python
5252
@@ -81,9 +81,9 @@ To mark unit errors as resolved in the `python-libjuju` client, you can call the
8181

8282
.. code:: python
8383
84-
my_unit.resolved()
84+
await my_unit.resolved()
8585
86-
> See more: `Unit.resolved()`
86+
> See more: `Unit.resolved() https://pythonlibjuju.readthedocs.io/en/latest/api/juju.unit.html#juju.unit.Unit.resolved`_
8787

8888

8989
Remove a unit

docs/howto/manage-users.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ To enable or disable a user, on a User object, use the `enable()` and `disable()
109109
110110
await user_object.disable()
111111
112-
You can also check if a user is enabled or disabled using the `enabled` and `disabled` properties on the Unit object.
112+
You can also check if a user is enabled or disabled using the `enabled` and `disabled` properties on the User object.
113113

114114
.. code:: python
115115

0 commit comments

Comments
 (0)