Skip to content

Fix make_docs.nu for Nu v0.98 #1554

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
merged 1 commit into from
Sep 18, 2024
Merged

Fix make_docs.nu for Nu v0.98 #1554

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions make_docs.nu
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,14 +103,14 @@ def command-frontmatter [commands_group, command_name] {
$commands_list
| get category
| each { |category|
let usage = ($commands_list | where category == $category | get usage | str join (char newline))
let usage = ($commands_list | where category == $category | get description | str join (char newline))
$'($category | str snake-case): |(char newline) ($usage)'
}
| str join (char newline)
)
let indented_usage = (
$commands_list
| get usage
| get description
| each {|elt| $" ($elt)"}
| str join (char newline)
)
Expand Down Expand Up @@ -141,7 +141,7 @@ def command-doc [command] {
let top = $"
# `($command.name)` for [($command.category)]\(/commands/categories/($command.category).md\)

<div class='command-title'>($command.usage | html-escape)</div>
<div class='command-title'>($command.description | html-escape)</div>

"

Expand Down Expand Up @@ -208,11 +208,11 @@ $"## Parameters
"
}

let ex = $command.extra_usage
let ex = $command.extra_description

# Certain commands' extra_usage is wrapped in code block markup to prevent their code from
# Certain commands' extra_description is wrapped in code block markup to prevent their code from
# being interpreted as markdown. This is strictly hard-coded for now.
let extra_usage = if $ex == "" {
let extra_description = if $ex == "" {
""
} else if $command.name in ['def-env' 'export def-env' 'as-date' 'as-datetime' ansi] {
$"## Notes
Expand Down Expand Up @@ -266,9 +266,9 @@ $"($example.description)
let sub_commands = if $one_word_cmd { scope commands | where name =~ $'^($command.name) ' } else { [] }
let sub_commands = if $one_word_cmd and ($sub_commands | length) > 0 {
let commands = $sub_commands
| select name usage type
| select name description type
| update name {|row| $"[`($row.name)`]\(/commands/docs/($row.name | safe-path).md\)" }
| upsert usage {|row| $row.usage | str replace -a '<' '\<' | str replace -a '>' '\>' }
| upsert description {|row| $row.description | str replace -a '<' '\<' | str replace -a '>' '\>' }
| to md --pretty
['', '## Subcommands:', '', $commands, ''] | str join (char newline)
} else { '' }
Expand All @@ -289,7 +289,7 @@ $"($example.description)
}

let doc = (
($top + $plugin_warning + $signatures + $flags + $parameters + $in_out + $examples + $extra_usage + $sub_commands)
($top + $plugin_warning + $signatures + $flags + $parameters + $in_out + $examples + $extra_description + $sub_commands)
| lines
| each {|line| ($line | str trim -r) }
| str join (char newline)
Expand Down