# HG changeset patch
# User Steve Losh <steve@stevelosh.com>
# Date 1278387040 14400
# Node ID 6800923435cd3cdbc1f1631bd9cf7e715d81a310
# Parent  e86b336ed78fba394d6ff370ba854350f0ba7a77
docs/cli: add docs for --edit

diff -r e86b336ed78f -r 6800923435cd docs/cli.rst
--- a/docs/cli.rst	Mon Jul 05 23:17:11 2010 -0400
+++ b/docs/cli.rst	Mon Jul 05 23:30:40 2010 -0400
@@ -149,6 +149,39 @@
 ``--edit``
 ----------
 
+Edit a comment or signoff. Usage::
+
+    hg review --edit IDENTIFIER [--yes | --no] [-m MESSAGE] [-l LINES] [--mdown] [FILE]
+
+Edit the comment or changeset with the given identifier.
+
+You can find the identifier of the item you would like to edit by running ``hg
+review --verbose`` to display identifiers.
+
+Any other options given (such as ``--message``, ``--yes`` or filenames) will
+replace the content of the item you edit.
+
+``--message VALUE``
+    Replace the comment or signoff message with VALUE (default: ``None`` (i.e.
+    "open an editor")).
+
+``--mdown``
+    Use Markdown to format the comment or signoff message (default: ``False``
+    (i.e. "Use the same formatting the item already has)).
+
+``--lines``
+    The line(s) of the file to comment on (default: ``None`` (i.e. "use the
+    same line the comment already has)). Returns an error if you're editing
+    a signoff or a review-level comment.
+
+``--yes``
+    Change the signoff to state the the changeset is "good" (default:
+    ``False``). Returns an error if you are not editing a signoff.
+
+``--no``
+    Change the signoff to state the the changeset is "bad" (default:
+    ``False``). Returns an error if you are not editing a signoff.
+
 
 .. _c-check: