Skip to content

Commit

Permalink
Update docs/interfaces.rst
Browse files Browse the repository at this point in the history
Added more backticks around inline code

Co-authored-by: Harry Slatyer <[email protected]>
  • Loading branch information
zakv and charmasaur authored Aug 26, 2020
1 parent fc608e8 commit c8e903d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/interfaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ When writing the file *exp_output.txt* there are three keywords and values you c
``uncer``, is optional, and refers to the uncertainty in the cost measurement made.
Note, M-LOOP by default assumes there is some noise corrupting costs, which is fitted and compensated for.
Hence, if there is some noise in your costs which you are unable to predict from a single measurement, do not worry, you do not have to estimate uncer, you can just leave it out.
Lastly bad can be used to indicate an experiment failed and was not able to produce a cost.
Lastly ``bad`` can be used to indicate an experiment failed and was not able to produce a cost.
If the experiment worked set ``bad = false`` and if it failed set ``bad = true``.

Note you do not have to include all of the keywords, you must provide at least a cost or the bad keyword set to true. For example a successful run can simply be::
Expand Down

0 comments on commit c8e903d

Please sign in to comment.