Skip to content

Commit 8e7b96a

Browse files
committed
Added documentation
1 parent 7878984 commit 8e7b96a

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,14 @@ The following line magics are supported:
9292
- `%use <lib1>, <lib2> ...` - injects code for supported libraries: artifact resolution, default imports, initialization code, type renderers
9393
- `%trackClasspath` - logs any changes of current classpath. Useful for debugging artifact resolution failures
9494
- `%trackExecution` - logs pieces of code that are going to be executed. Useful for debugging of libraries support
95+
- `%output [--max-cell-size=N] [--max-buffer=N] [--max-buffer-newline=N] [--max-time=N] [--no-stdout] [--reset-to-defaults]` -
96+
output capturing settings.
97+
- `max-cell-size` specifies the characters count which may be printed to stdout. Default is 100000.
98+
- `max-buffer` - max characters count stored in internal buffer before being sent to client. Default is 10000.
99+
- `max-buffer-newline` - same as above, but trigger happens only if newline character was encountered. Default is 100.
100+
- `max-time` - max time in milliseconds before the buffer is sent to client. Default is 100.
101+
- `no-stdout` - don't capture output. Default is false.
102+
- `reset-to-defaults` - reset all output settings that were set with magics to defaults
95103

96104
### Supported Libraries
97105

src/main/kotlin/org/jetbrains/kotlin/jupyter/magics.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ enum class ReplLineMagics(val desc: String, val argumentsUsage: String? = null,
1212
trackClasspath("log current classpath changes"),
1313
trackExecution("log code that is going to be executed in repl", visibleInHelp = false),
1414
dumpClassesForSpark("stores compiled repl classes in special folder for Spark integration", visibleInHelp = false),
15-
output("setup output settings", "--max 1000 --no-stdout --time-interval-ms 100 --buffer-limit 400")
15+
output("setup output settings", "--max-cell-size=1000 --no-stdout --max-time=100 --max-buffer=400")
1616
}
1717

1818
fun processMagics(repl: ReplForJupyter, code: String): String {

0 commit comments

Comments
 (0)