Skip to content

Commit 81995d2

Browse files
authored
Merge pull request #25 from edx/bmedx/fix_getting_started_format
Fixup formatting issue with the Getting Started doc
2 parents 590af05 + 069efac commit 81995d2

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
@@ -95,14 +95,22 @@ In your ``source_path`` add some comments with annotations in them. Examples:
9595
// .. annotation_token: And this!
9696
9797
98-
Run a static annotation search
99-
------------------------------
98+
Run an annotation search
99+
------------------------
100100

101101
.. code-block:: bash
102102
103-
$ code_annotations django_find_annotations --config_file /path/to/your/config
104103
$ code_annotations static_find_annotations --config_file /path/to/your/config
105104
105+
106+
If you have ``DJANGO_SETTINGS_MODULE`` correctly configured and have annotated some models you can also run a Django
107+
model annotation search:
108+
109+
.. code-block:: bash
110+
111+
$ code_annotations django_find_annotations --config_file /path/to/your/config
112+
113+
106114
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
107115
your favorite text editor to make sure all of your annotations were found. Different verbosity levels are available for
108116
this command, try ``-v``, ``-vv``, and ``-vvv`` to assist in debugging. ``--help`` will provide information on all of

0 commit comments

Comments
 (0)