Skip to content

Commit ff7bf45

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

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
@@ -130,10 +130,10 @@ async def get_document(
130130
file_format: Literal["json", "text"],
131131
copy: bool = True,
132132
) -> YBaseDoc | None:
133-
"""Get a read-only view of the shared model for the matching document.
133+
"""Get a view of the shared model for the matching document.
134134
135-
The returned shared model is a fork, meaning that any changes made to it
136-
will not be propagated to the shared model used by the application.
135+
If `copy=True`, the returned shared model is a fork, meaning that any changes
136+
made to it will not be propagated to the shared model used by the application.
137137
"""
138138
file_id_manager = self.serverapp.web_app.settings["file_id_manager"]
139139
file_id = file_id_manager.index(path)

0 commit comments

Comments
 (0)