Skip to content

Commit a87e20e

Browse files
Update the docstring to reflect the copy arg
Co-authored-by: David Brochart <[email protected]>
1 parent 6cd09ef commit a87e20e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

jupyter_collaboration/app.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,10 +142,10 @@ async def get_document(
142142
file_format: Literal["json", "text"],
143143
copy: bool = True,
144144
) -> YBaseDoc | None:
145-
"""Get a read-only view of the shared model for the matching document.
145+
"""Get a view of the shared model for the matching document.
146146
147-
The returned shared model is a fork, meaning that any changes made to it
148-
will not be propagated to the shared model used by the application.
147+
If `copy=True`, the returned shared model is a fork, meaning that any changes
148+
made to it will not be propagated to the shared model used by the application.
149149
"""
150150
file_id_manager = self.serverapp.web_app.settings["file_id_manager"]
151151
file_id = file_id_manager.index(path)

0 commit comments

Comments
 (0)