diff --git a/docs/git-draft.adoc b/docs/git-draft.adoc index 75d2a2c..bdbfe9b 100644 --- a/docs/git-draft.adoc +++ b/docs/git-draft.adoc @@ -28,14 +28,14 @@ git draft [options] --templates [--json | [--edit] TEMPLATE] `git-draft` is a git-centric way to edit code with AI. -Its workhorse command is `git draft --new` (and its shorthand, `git draft`) which suggests code changes using LLMs. +Its workhorse command is `git draft` (shorthand for `git draft --new`) which suggests code changes using LLMs. Prompts can be specified inline or via customizable templates. -Prompt templates can get augmented with information about the files in the repository, and give the LLM access to tools for reading and writing files. +Prompt templates can be augmented with information about the files in the repository, and give the LLM access to tools for reading and writing files. Once the response has been received and changes applied, a commit is created in a dedicated draft branch. -The `--new` step can be repeated as many times as needed. +This command can be repeated as many times as needed within a draft branch to iterate on the changes. +Manual changes can of course be included. -Once satisfied with the changes, run `git draft --quit` to return to the original branch. -This keeps the working directory's current state. +Once satisfied with the changes, run `git draft --quit` to return to the original branch, keeping the working directory's current state. == Options @@ -91,10 +91,6 @@ Go back to the draft's origin branch, keeping the working directory's current st This will delete the draft branch and its upstream. Generated commits and the draft branch's final state remain available via `ref/drafts`. ---root:: -Repository search root. -Defaults to the current working directory. - -T:: --templates:: With no argument, lists available templates. diff --git a/src/git_draft/__main__.py b/src/git_draft/__main__.py index 400a02f..b4f3e2b 100644 --- a/src/git_draft/__main__.py +++ b/src/git_draft/__main__.py @@ -48,7 +48,7 @@ def new_parser() -> optparse.OptionParser: ) parser.add_option( "--root", - help="path used to locate repository root", + help=optparse.SUPPRESS_HELP, # Not needed when invoked via git dest="root", )