Skip to content

fix(docs): purge_data/purge_objects typo #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vergeev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(docs): purge_data/purge_objects typo #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/source/rgwadmin/user-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ Remove Bucket

Remove a bucket using :func:`~rgwadmin.rgw.RGWAdmin.remove_bucket`. You must
pass purge_objects to delete a non-empty bucket. If called on a non-empty bucket
when ``purge_data=False``, this will throw a :class:`~rgwadmin.exceptions.BucketNotEmpty`
when ``purge_objects=False``, this will throw a :class:`~rgwadmin.exceptions.BucketNotEmpty`
exception.

.. code-block:: python
Expand All @@ -394,7 +394,7 @@ exception.
'RequestId': 'tx0000000000000002a6446-005ed13a10-ad92-default',
'HostId': 'ad92-default-default'}

>>> rgw.remove_bucket(bucket='bucket1', purge_data=True)
>>> rgw.remove_bucket(bucket='bucket1', purge_objects=True)


Unlink Bucket
Expand Down