Skip to content

docs: Fix sample code for folder locks endpoint #888

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

Merged
mwwoda merged 1 commit into from
Mar 12, 2025
Merged

docs: Fix sample code for folder locks endpoint #888

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
8 changes: 4 additions & 4 deletions docs/usage/folders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,11 +458,11 @@ Create a Folder Lock
-------------

To lock a folder, call
[`client.folders(folder_id).create_lock()`][create-folder-lock]
[`client.folder(folder_id).create_lock()`][create-folder-lock]
with the ID of the folder. This prevents the folder from being moved and/or deleted.

```python
lock = client.folders(folder_id).create_lock()
lock = client.folder(folder_id).create_lock()
print(f'Created a lock with ID {lock.folder.id}')
```

Expand All @@ -473,11 +473,11 @@ Get Folder Locks
-------------------------

To retrieve a list of the locks on a folder, call
[`client.folders(folder_id).get_locks()][get-folder-locks]
[`client.folder(folder_id).get_locks()][get-folder-locks]
with the ID of the folder. Currently only one lock can exist per folder. Folder locks define access restrictions placed by folder owners to prevent specific folders from being moved or deleted.

```python
locks = client.folders(folder_id).get_locks()
locks = client.folder(folder_id).get_locks()
lock = locks.next()
print(f'A lock on a folder with ID {lock.folder.id}')
```
Expand Down
Loading