Skip to content

Commit 069efac

Browse files
committed
Fixup formatting issue with the Getting Started doc
1 parent 95571ce commit 069efac

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/getting_started.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,14 +94,22 @@ In your ``source_path`` add some comments with annotations in them. Examples:
9494
// .. annotation_token: And this!
9595
9696
97-
Run a static annotation search
98-
------------------------------
97+
Run an annotation search
98+
------------------------
9999

100100
.. code-block:: bash
101101
102-
$ code_annotations django_find_annotations --config_file /path/to/your/config
103102
$ code_annotations static_find_annotations --config_file /path/to/your/config
104103
104+
105+
If you have ``DJANGO_SETTINGS_MODULE`` correctly configured and have annotated some models you can also run a Django
106+
model annotation search:
107+
108+
.. code-block:: bash
109+
110+
$ code_annotations django_find_annotations --config_file /path/to/your/config
111+
112+
105113
If all went well you should see a message telling you the name of the report file that was written out. Take a look in
106114
your favorite text editor to make sure all of your annotations were found. Different verbosity levels are available for
107115
this command, try ``-v``, ``-vv``, and ``-vvv`` to assist in debugging. ``--help`` will provide information on all of

0 commit comments

Comments
 (0)