docs: improve README documentation and structure#36
Merged
maxim-uvarov merged 5 commits intomainfrom Dec 31, 2025
Merged
Conversation
Add documentation for 4 public commands that were exported in mod.nu but missing from README: - generate-numd - extract-command-code - list-exported-commands - module-commands-code-to-record Also add help block for set-x showing --regex and --quiet flags. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- "divided on blocks" → "divided into blocks" - "a command code" → "command code" - "nushell cli" → "Nushell CLI" - Add missing space after # in todo comment - "separately here" → "separate" - "make a record" → "Make a record" (sentence case) - Fix module-commands-code-to-record docstring to match actual behavior - "result" → "results" (plural) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Reorganize into logical sections: Embeds, Dependency Analysis, Script Profiling, Utilities - Fix heading hierarchy: helper commands now use H4 under H3 parent - Standardize all code fences to `nushell` - Remove redundant set-x prose (help block already explains it) - Remove emoji from title for cleaner look - Improve descriptions to be before help blocks - Capitalize section descriptions consistently 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The default value "\n+\n" contains actual newlines which caused awkward multi-line display in --help output. Now uses optional parameter with default applied in function body, and documents the default in the description. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
generate-numd,extract-command-code,list-exported-commands,module-commands-code-to-recordcommands.nuset-xregex default display (moved from signature to body to avoid multiline help output)Changes
README.md
nushellcommands.nu
module-commands-code-to-recorddocstring to match behaviorset-x --regexparameter: default moved to function body with documentation in descriptionTest plan
nu toolkit.nu test-unit)nu toolkit.nu test-integration)dotnu set-x --helpdisplays cleanly on one line🤖 Generated with Claude Code