docs(update): latest

profclems · Oct 26, 2020 · f0318a0 · f0318a0
1 parent 69faba7
commit f0318a0
Show file tree

Hide file tree

Showing 24 changed files with 276 additions and 13 deletions.
diff --git a/docs/source/alias/help.rst b/docs/source/alias/help.rst
@@ -0,0 +1,25 @@
+.. _glab_alias_help:
+
+glab alias help
+---------------
+
+Help about any command
+
+Synopsis
+~~~~~~~~
+
+
+Help provides help for any command in the application.
+Simply type alias help [path to command] for full details.
+
+::
+
+  glab alias help [command] [flags]
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help   Show help for command
+
diff --git a/docs/source/auth/help.rst b/docs/source/auth/help.rst
@@ -0,0 +1,25 @@
+.. _glab_auth_help:
+
+glab auth help
+--------------
+
+Help about any command
+
+Synopsis
+~~~~~~~~
+
+
+Help provides help for any command in the application.
+Simply type auth help [path to command] for full details.
+
+::
+
+  glab auth help [command] [flags]
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help   Show help for command
+
diff --git a/docs/source/config/help.rst b/docs/source/config/help.rst
@@ -0,0 +1,25 @@
+.. _glab_config_help:
+
+glab config help
+----------------
+
+Help about any command
+
+Synopsis
+~~~~~~~~
+
+
+Help provides help for any command in the application.
+Simply type config help [path to command] for full details.
+
+::
+
+  glab config help [command] [flags]
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help   Show help for command
+
diff --git a/docs/source/issue/help.rst b/docs/source/issue/help.rst
@@ -0,0 +1,26 @@
+.. _glab_issue_help:
+
+glab issue help
+---------------
+
+Help about any command
+
+Synopsis
+~~~~~~~~
+
+
+Help provides help for any command in the application.
+Simply type issue help [path to command] for full details.
+
+::
+
+  glab issue help [command] [flags]
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help              Show help for command
+  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL
+
diff --git a/docs/source/label/help.rst b/docs/source/label/help.rst
@@ -0,0 +1,26 @@
+.. _glab_label_help:
+
+glab label help
+---------------
+
+Help about any command
+
+Synopsis
+~~~~~~~~
+
+
+Help provides help for any command in the application.
+Simply type label help [path to command] for full details.
+
+::
+
+  glab label help [command] [flags]
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help              Show help for command
+  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL
+
diff --git a/docs/source/mr/approvers.rst b/docs/source/mr/approvers.rst
@@ -13,7 +13,7 @@ List merge request eligible approvers
 
 ::
 
-  glab mr approvers <id> [flags]
+  glab mr approvers [<id> | <branch>] [flags]
 
 Options inherited from parent commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/mr/checkout.rst b/docs/source/mr/checkout.rst
@@ -13,7 +13,7 @@ Checkout to an open merge request
 
 ::
 
-  glab mr checkout <mr-id> [flags]
+  glab mr checkout <id> [flags]
 
 Options
 ~~~~~~~

diff --git a/docs/source/mr/close.rst b/docs/source/mr/close.rst
@@ -13,7 +13,7 @@ Close merge requests
 
 ::
 
-  glab mr close <id> [flags]
+  glab mr close [<id> | <branch>] [flags]
 
 Options inherited from parent commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/mr/delete.rst b/docs/source/mr/delete.rst
@@ -13,7 +13,7 @@ Delete merge requests
 
 ::
 
-  glab mr delete <id> [flags]
+  glab mr delete [<id> | <branch>] [flags]
 
 Examples
 ~~~~~~~~

diff --git a/docs/source/mr/diff.rst b/docs/source/mr/diff.rst
@@ -0,0 +1,32 @@
+.. _glab_mr_diff:
+
+glab mr diff
+------------
+
+View changes in a merge request
+
+Synopsis
+~~~~~~~~
+
+
+View changes in a merge request
+
+::
+
+  glab mr diff [<id> | <branch>] [flags]
+
+Options
+~~~~~~~
+
+::
+
+      --color string   Use color in diff output: {always|never|auto} (default "auto")
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help              Show help for command
+  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL
+
diff --git a/docs/source/mr/help.rst b/docs/source/mr/help.rst
@@ -0,0 +1,26 @@
+.. _glab_mr_help:
+
+glab mr help
+------------
+
+Help about any command
+
+Synopsis
+~~~~~~~~
+
+
+Help provides help for any command in the application.
+Simply type mr help [path to command] for full details.
+
+::
+
+  glab mr help [command] [flags]
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help              Show help for command
+  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL
+
diff --git a/docs/source/mr/index.rst b/docs/source/mr/index.rst
@@ -37,6 +37,7 @@ Subcommands
    close <close>
    create <create>
    delete <delete>
+   diff <diff>
    for <for>
    issues <issues>
    list <list>

diff --git a/docs/source/mr/issues.rst b/docs/source/mr/issues.rst
@@ -13,7 +13,7 @@ Get issues related to a particular merge request.
 
 ::
 
-  glab mr issues <id> [flags]
+  glab mr issues [<id> | <branch>] [flags]
 
 Examples
 ~~~~~~~~

diff --git a/docs/source/mr/note.rst b/docs/source/mr/note.rst
@@ -13,7 +13,7 @@ Add a comment or note to merge request
 
 ::
 
-  glab mr note <merge-request-id> [flags]
+  glab mr note [<id> | <branch>] [flags]
 
 Options
 ~~~~~~~

diff --git a/docs/source/mr/rebase.rst b/docs/source/mr/rebase.rst
@@ -13,7 +13,7 @@ If you don’t have permissions to push to the merge request’s source branch -
 
 ::
 
-  glab mr rebase <id> [flags]
+  glab mr rebase [<id> | <branch>] [flags]
 
 Options inherited from parent commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/mr/reopen.rst b/docs/source/mr/reopen.rst
@@ -13,7 +13,7 @@ Reopen merge requests
 
 ::
 
-  glab mr reopen <id> [flags]
+  glab mr reopen [<id> | <branch>] [flags]
 
 Options inherited from parent commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/mr/revoke.rst b/docs/source/mr/revoke.rst
@@ -13,7 +13,7 @@ Revoke approval on a merge request <id>
 
 ::
 
-  glab mr revoke <id> [flags]
+  glab mr revoke [<id> | <branch>] [flags]
 
 Options inherited from parent commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/mr/subscribe.rst b/docs/source/mr/subscribe.rst
@@ -13,7 +13,7 @@ Subscribe to merge requests
 
 ::
 
-  glab mr subscribe <id> [flags]
+  glab mr subscribe [<id> | <branch>] [flags]
 
 Options inherited from parent commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/mr/todo.rst b/docs/source/mr/todo.rst
@@ -13,7 +13,7 @@ Add a ToDo to merge request
 
 ::
 
-  glab mr todo <merge-request-id> [flags]
+  glab mr todo [<id> | <branch>] [flags]
 
 Options inherited from parent commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/mr/unsubscribe.rst b/docs/source/mr/unsubscribe.rst
@@ -13,7 +13,7 @@ Unsubscribe from merge requests
 
 ::
 
-  glab mr unsubscribe <id> [flags]
+  glab mr unsubscribe [<id> | <branch>] [flags]
 
 Options inherited from parent commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/mr/update.rst b/docs/source/mr/update.rst
@@ -13,7 +13,7 @@ Update merge requests
 
 ::
 
-  glab mr update <id> [flags]
+  glab mr update [<id> | <branch>] [flags]
 
 Examples
 ~~~~~~~~

diff --git a/docs/source/pipeline/help.rst b/docs/source/pipeline/help.rst
@@ -0,0 +1,26 @@
+.. _glab_pipeline_help:
+
+glab pipeline help
+------------------
+
+Help about any command
+
+Synopsis
+~~~~~~~~
+
+
+Help provides help for any command in the application.
+Simply type pipeline help [path to command] for full details.
+
+::
+
+  glab pipeline help [command] [flags]
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help              Show help for command
+  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL
+
diff --git a/docs/source/release/help.rst b/docs/source/release/help.rst
@@ -0,0 +1,26 @@
+.. _glab_release_help:
+
+glab release help
+-----------------
+
+Help about any command
+
+Synopsis
+~~~~~~~~
+
+
+Help provides help for any command in the application.
+Simply type release help [path to command] for full details.
+
+::
+
+  glab release help [command] [flags]
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help              Show help for command
+  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or the project ID or full URL
+
diff --git a/docs/source/repo/help.rst b/docs/source/repo/help.rst
@@ -0,0 +1,25 @@
+.. _glab_repo_help:
+
+glab repo help
+--------------
+
+Help about any command
+
+Synopsis
+~~~~~~~~
+
+
+Help provides help for any command in the application.
+Simply type repo help [path to command] for full details.
+
+::
+
+  glab repo help [command] [flags]
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help   Show help for command
+