forked from extern/nushell
eb3c2c9e76
This commit applied adds comments preceding a command to the LiteCommands new
field `comments`.
This can be usefull for example when defining a function with `def`. Nushell
could pick up the comments and display them when the user types `help my_def_func`.
Example
```shell
def my_echo [arg] { echo $arg }
```
The LiteCommand def will now contain the comments `My echo` and `It's much
better :)`.
The comment is not associated with the next command if there is a (or multiple) newline
between them.
Example
```shell
echo 42
```
This new functionality is similar to DocStrings. One might introduce a special
notation for such DocStrings, so that the parser can differentiate better
between discardable comments and usefull documentation.
|
||
|---|---|---|
| .. | ||
| nu_plugin_binaryview | ||
| nu_plugin_chart | ||
| nu_plugin_fetch | ||
| nu_plugin_from_bson | ||
| nu_plugin_from_sqlite | ||
| nu_plugin_inc | ||
| nu_plugin_match | ||
| nu_plugin_post | ||
| nu_plugin_ps | ||
| nu_plugin_s3 | ||
| nu_plugin_selector | ||
| nu_plugin_start | ||
| nu_plugin_sys | ||
| nu_plugin_textview | ||
| nu_plugin_to_bson | ||
| nu_plugin_to_sqlite | ||
| nu_plugin_tree | ||
| nu_plugin_xpath | ||
| nu-cli | ||
| nu-data | ||
| nu-errors | ||
| nu-json | ||
| nu-parser | ||
| nu-plugin | ||
| nu-protocol | ||
| nu-source | ||
| nu-stream | ||
| nu-table | ||
| nu-test-support | ||
| nu-value-ext | ||