Skip to content

Commit

Permalink
Fixed typos with docs.
Browse files Browse the repository at this point in the history
Added link to Workshop slides.
  • Loading branch information
RoryBarnes committed Jun 7, 2021
1 parent 4100228 commit fc26c67
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ are available in separate repositories.
vplot
parametersweep
tutorials
Workshop Lectures <http://faculty.washington.edu/rkb9/vplanet/Workshop21/>
developers
authors
repos
Expand Down
7 changes: 5 additions & 2 deletions docs/option.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ should be set to 0 as shown. Otherwise, set the value to equal the sum of module
bits, such as is done for the inclination:

.. code-block:: bash
options[OPT_INC].iModuleBit = DISTORB + SPINBODY;
In other words, each module is assigned a unique integer that is a power of 2 so
Expand All @@ -80,13 +81,15 @@ parameter that is used with the -H command line option, e.g. the verbosity
benefits from a bit more explanation:

.. code-block:: bash
sprintf(options[OPT_VERBOSE].cLongDescr,
sprintf(options[OPT_VERBOSE].cLongDescr,
"Set how much text is written to the screen. 0 = no output, 1 = only\n"
"errors, 2 = progress updates, 3 = statements about input choices, 4 =\n"
"information about unit choices, 5 = all possible output. Note that levels\n"
"0 and 5 can be set at execution with the -q and -v options, respectively."
:note::
.. note::
Any field that is omitted will be set to the default values that are defined
in output.c:InitializeOutput.
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
VPLanet Tutorials
=================
Tutorials
=========

Please view the following pages for written descriptions of how to:

Expand Down
4 changes: 2 additions & 2 deletions src/options.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
1) Add integer definition here
2) Add new option properties in InitializeOptions
3) Write new fnReadOptions function
3) If necessary, modify the ReadOptions subroutine
4) If necessary, modify the WriteLog subroutine
4) If necessary, modify the ReadOptions subroutine
5) If necessary, modify the Verify process
*/

Expand Down

0 comments on commit fc26c67

Please sign in to comment.