Skip to content
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.

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

modules are missing extra usage in the documentation #172

Closed
amtoine opened this issue Jan 27, 2024 · 1 comment · Fixed by #173
Closed

modules are missing extra usage in the documentation #172

amtoine opened this issue Jan 27, 2024 · 1 comment · Fixed by #173
Labels
bug Something isn't working as expected documentation Improvements or additions to documentation wait-for-upstream Need to wait for an upstream project to push some changes.

Comments

@amtoine
Copy link
Owner

amtoine commented Jan 27, 2024

Describe the bug

related to

How to reproduce

  1. look at the source of nu-git-manager => it has a usage and extra usage
  2. look at the documentation of the module => there is only the usage

Expected behavior

i expected to see the extra usage as well

Configuration

key value
version 0.89.0
branch
commit_hash
build_os linux-x86_64
build_target x86_64-unknown-linux-gnu
rust_version rustc 1.73.0 (cc66ad468 2023-10-03)
rust_channel stable-x86_64-unknown-linux-gnu
cargo_version cargo 1.73.0 (9c4383fb5 2023-08-26)
build_time 2024-01-11 18:20:14 +01:00
build_rust_channel release
allocator mimalloc
features default, sqlite, trash, which, zip
installed_plugins clipboard copy, clipboard paste, gstat, nu_plugin_explore

Additional context

No response

@amtoine amtoine added bug Something isn't working as expected documentation Improvements or additions to documentation wait-for-upstream Need to wait for an upstream project to push some changes. labels Jan 27, 2024
@amtoine
Copy link
Owner Author

amtoine commented Jan 27, 2024

this will only require to apply the following patch and regenerate the documentation when Nushell ships the fix

diff --git a/toolkit.nu b/toolkit.nu
index 8c82379..a34b0cb 100644
--- a/toolkit.nu
+++ b/toolkit.nu
@@ -325,6 +325,8 @@ def document-module [
             "## Description",
             $module.usage,
             "",
+            $module.extra_usage,
+            "",
             "## Commands",
             $commands,
         ]

@amtoine amtoine linked a pull request Jan 28, 2024 that will close this issue
amtoine added a commit that referenced this issue Jan 28, 2024
amtoine added a commit that referenced this issue Feb 7, 2024
@amtoine amtoine closed this as completed Feb 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working as expected documentation Improvements or additions to documentation wait-for-upstream Need to wait for an upstream project to push some changes.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant