|
119 | 119 | " Specify the last option if you want to use `pystata`'s [default setting](https://www.stata.com/python/pystata18/config.html#pystata.config.set_graph_format). \n", |
120 | 120 | "- `graph_width`/`graph_height`: By default, graphs are generated with width 5.5in and height 4in. The width or height may be specified as a number (interpreted as inches) or a number and its unit (in, cm, or px). So `3` and `3in` are equivalent. Other valid examples: `300px` and `7.2 cm`. (Note: These values may also be set to `default`, which values alone enable the `xsize` and `ysize` options on Stata graph commands to influence the graph output size. Any values other than `default` override the `xsize` and `ysize` options.)\n", |
121 | 121 | "- `echo`: controls the echo of commands, with the default being 'None':\n", |
122 | | - " - 'True': the kernel will echo all commands. \n", |
123 | | - " - 'False': the kernel will not echo single-line commands.\n", |
124 | | - " - 'None': the kernel will not echo any command. \n", |
| 122 | + " - 'True': echo all commands. \n", |
| 123 | + " - 'False': for Stata 18.5+, not echo any command (native Stata implementation); otherwise echo (only) multi-line commands.\n", |
| 124 | + " - 'None': not echo any command (custom nbstata implementation). \n", |
125 | 125 | "- `missing`: What to display for a missing value in the output of the `%browse`, `%head`, and `%tail` magics. Default is '.', following Stata. To defer to pandas's format for `NaN`, specify 'pandas'.\n", |
126 | 126 | "- `browse_auto_height`: Whether to set 'height: 100%' for the [%browse](#browse-head-tail-and-frame-equivalents) widget (default: 'True'):\n", |
127 | 127 | " - 'True': allows browse widget to expand to height of its container, such as when using 'Create New View for Output' in Jupyter Lab.\n", |
|
442 | 442 | "cell_type": "markdown", |
443 | 443 | "metadata": {}, |
444 | 444 | "source": [ |
445 | | - "The default `echo = None` configuration does some complicated things under the hood to emulate functionality that *pystata* does not directly support: running multi-line Stata code without echoing the commands. While extensive automatic tests are in place to help ensure its reliability, unanticipated issues may arise. If, while using this mode, a particular code cell is not working as expected, try placing the `%%echo` magic at the top of it to see if that resolves the issue. (If so, please report that [here](https://github.com/hugetim/nbstata/issues/new?labels=bug).) You can also avoid such potential issues by setting the config `echo = False`, which will at least not echo single-line Stata commands though it will echo multiple commands." |
| 445 | + "With Stata 18.5+, `echo = False` is recommended.\n", |
| 446 | + "\n", |
| 447 | + "The default `echo = None` configuration does some complicated things under the hood to emulate functionality that *pystata* does not directly support: running multi-line Stata code without echoing the commands. While extensive automatic tests are in place to help ensure its reliability, unanticipated issues may arise. If, while using this mode, a particular code cell is not working as expected, try placing the `%%echo` magic at the top of it to see if that resolves the issue. (If so, please report that [here](https://github.com/hugetim/nbstata/issues/new?labels=bug).) You can also avoid such potential issues by setting the config `echo = False`, which will at least not echo single-line Stata commands though it will echo multiple commands for Stata 17 and 18.0." |
446 | 448 | ] |
447 | 449 | }, |
448 | 450 | { |
|
0 commit comments