generate the documentation

amtoine · Dec 13, 2023 · 32f6a7d · 32f6a7d
1 parent 8a8559a
commit 32f6a7d
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 3 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -21,6 +21,7 @@
 - [`gm repo goto root`](nu-git-manager-sugar/git/gm-repo-goto-root.md)
 - [`gm repo is-ancestor`](nu-git-manager-sugar/git/gm-repo-is-ancestor.md)
 - [`gm repo ls`](nu-git-manager-sugar/git/gm-repo-ls.md)
+- [`gm repo query`](nu-git-manager-sugar/git/gm-repo-query.md)
 - [`gm repo remote list`](nu-git-manager-sugar/git/gm-repo-remote-list.md)
 - [`gm repo switch`](nu-git-manager-sugar/git/gm-repo-switch.md)
 - [`setup`](nu-git-manager-sugar/git/prompt/setup.md)

diff --git a/docs/nu-git-manager-sugar/git/gm-repo-ls.md b/docs/nu-git-manager-sugar/git/gm-repo-ls.md
@@ -12,6 +12,6 @@ get some information about a repo
 - description: the path to the repo (defaults to `.`)
 
 ## Signatures
-| input     | output                                                                                                                                                             |
-| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `nothing` | `record<path: string, name: string, staged: int, unstaged: int, untracked: int, last_commit: record<date: datetime, title: string, hash: string>, branch: string>` |
+| input     | output                                                                                                                                                                                        |
+| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `nothing` | `record<path: string, name: string, staged: list<string>, unstaged: list<string>, untracked: list<string>, last_commit: record<date: datetime, title: string, hash: string>, branch: string>` |
diff --git a/docs/nu-git-manager-sugar/git/gm-repo-query.md b/docs/nu-git-manager-sugar/git/gm-repo-query.md
@@ -0,0 +1,17 @@
+# `nu-git-manager-sugar git gm repo query`
+## Description
+TODO: documentation
+
+
+
+## Parameters
+- parameter_name: table
+- parameter_type: positional
+- syntax_shape: completable<string>
+- is_optional: false
+- custom_completion: git-query-tables
+
+## Signatures
+| input     | output  |
+| --------- | ------- |
+| `nothing` | `table` |
diff --git a/docs/nu-git-manager-sugar/git/index.md b/docs/nu-git-manager-sugar/git/index.md
@@ -12,6 +12,7 @@
 - [`gm repo goto root`](gm-repo-goto-root.md)
 - [`gm repo is-ancestor`](gm-repo-is-ancestor.md)
 - [`gm repo ls`](gm-repo-ls.md)
+- [`gm repo query`](gm-repo-query.md)
 - [`gm repo remote list`](gm-repo-remote-list.md)
 - [`gm repo switch`](gm-repo-switch.md)