Skip to content

Commit 874a7ea

Browse files
authored
docs: 📝 update configuration doc (#195)
1 parent 830ee61 commit 874a7ea

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/source/configuration.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,22 @@ you happen to delete it, there shouldn't be any serious consequence either.
1010
There are a number of settings that you can change:
1111

1212
```bash
13+
# To enable or disable RTC(Real-Time Collaboration) (default: False).
14+
# If True, RTC will be disabled.
15+
jupyter lab --YDocExtension.disable_rtc=True
16+
1317
# The delay of inactivity (in seconds) after which a document is saved to disk (default: 1).
1418
# If None, the document will never be saved.
15-
jupyter lab --collaborative --YDocExtension.document_save_delay=0.5
19+
jupyter lab --YDocExtension.document_save_delay=0.5
1620

1721
# The period (in seconds) to check for file changes on disk (default: 1).
1822
# If 0, file changes will only be checked when saving.
19-
jupyter lab --collaborative --YDocExtension.file_poll_interval=2
23+
jupyter lab --YDocExtension.file_poll_interval=2
2024

2125
# The delay (in seconds) to keep a document in memory in the back-end after all clients disconnect (default: 60).
2226
# If None, the document will be kept in memory forever.
23-
jupyter lab --collaborative --YDocExtension.document_cleanup_delay=100
27+
jupyter lab --YDocExtension.document_cleanup_delay=100
2428

2529
# The YStore class to use for storing Y updates (default: JupyterSQLiteYStore).
26-
jupyter lab --collaborative --YDocExtension.ystore_class=ypy_websocket.ystore.TempFileYStore
30+
jupyter lab --YDocExtension.ystore_class=ypy_websocket.ystore.TempFileYStore
2731
```

0 commit comments

Comments
 (0)