add the example results to the documentation pages #807
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to
help
nushell#8189As introduced in nushell/nushell#8189 and nushell/nushell#8319, the
$nu.scope.commands
structure now holds theresult
s of the commandexample
s 👍in order to generate accurate documentation pages, the
make_docs.nu
script needs to use$nu.scope.commands.example.result
in addition to$nu.scope.commands.example.description
and$nu.scope.commands.example.example
this PR uses
$example.result
in thecommand-doc
command right after the> ($example.example)
line, adding the result to the page.example
on the
merge
commandgives