Skip to content

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

Merged
132ikl merged 4 commits into
nushell:mainfrom
raoulkent:main
Jun 6, 2025
Merged

feature(make_docs.nu): adjust the input/output section generation#1930
132ikl merged 4 commits into
nushell:mainfrom
raoulkent:main

Conversation

@raoulkent
Copy link
Copy Markdown
Contributor

@raoulkent raoulkent commented Jun 5, 2025

Now uses the data directly from help {command} to ensure that the table
is fully populated by all input/output combinations.

Is meant to address #1931

However, it is lacking in that it now is not clear which of the IO pairs is the default etc (details found when inspecting with scope commands. However, scope commands instead hides details when applying deduping logic

sigs.dedup_by(|(k1, _), (k2, _)| k1 == k2);

raoulkent added 3 commits June 3, 2025 16:44
now uses the data directly from help {command} to ensure that the table
is fully populated by all input/output combinations.
@fdncred
Copy link
Copy Markdown
Contributor

fdncred commented Jun 5, 2025

However, it is lacking in that it now is not clear which of the IO pairs is the default

I don't think there is a default. Just a list.

@132ikl
Copy link
Copy Markdown
Member

132ikl commented Jun 5, 2025

I don't think there is a default. Just a list.

this is correct: while from a user perspective one is the default and one is flag specific, this isn't encoded in our Signature right now. this is something that has to be fixed in nushell itself, we can't band-aid fix it in the docs. I think this PR is the correct solution for #1931

@raoulkent raoulkent reopened this Jun 5, 2025
@raoulkent
Copy link
Copy Markdown
Contributor Author

@fdncred @132ikl cheers. Reopened the pr

Copy link
Copy Markdown
Member

@132ikl 132ikl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

almost there, thank you!

Comment thread make_docs.nu Outdated
Co-authored-by: 132ikl <132@ikl.sh>
@132ikl 132ikl merged commit 6b6f2aa into nushell:main Jun 6, 2025
2 checks passed
@132ikl
Copy link
Copy Markdown
Member

132ikl commented Jun 6, 2025

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants