Skip to content

feature(make_docs.nu): adjust the input/output section generation #1930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
132ikl merged 4 commits into from
Jun 6, 2025
Merged

feature(make_docs.nu): adjust the input/output section generation #1930

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4dc7585
docs(closure.md): Add simple examples of using closures
raoulkent Jun 3, 2025
2e9a206
feature(make_docs.nu): adjust the input/output section generation
raoulkent Jun 5, 2025
5f92c99
Merge branch 'nushell:main' into main
raoulkent Jun 5, 2025
0677edb
Update make_docs.nu
raoulkent Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions make_docs.nu
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

def plugin-paths [ nu_path?: path ] {
const PLUGINS = [
nu_plugin_inc,
Expand Down Expand Up @@ -243,10 +242,21 @@ $"## Notes
# FIXME: Parentheses are required here to mutate $input_output, otherwise it won't work, maybe a bug?
$input_output = ($input_output | append [[input output]; [$input $output]])
}
let in_out = if ($input_output | length) > 0 {
let markdown = ($input_output | sort-by input | to md --pretty | str replace -a '<' '\<' | str replace -a '>' '\>')
['', '## Input/output types:', '', $markdown, ''] | str join (char newline)
} else { '' }
# Input/output types: use help commands
let input_output_table = (
help commands
| where name == $command.name
| get input_output
| first
| to md --pretty
| str replace -a '<' '&lt;'
| str replace -a '>' '&gt;'
)
let in_out = if ($input_output_table | is-empty) {
''
} else {
['', '## Input/output types:', '', $input_output_table, ''] | str join (char newline)
}

let examples = if ($command.examples | length) > 0 {
let example_top = $"## Examples(char newline)(char newline)"
Expand Down