Skip to content

Commit

Permalink
Adjust value for radius since it changed in 994cd0c
Browse files Browse the repository at this point in the history
Make radius a float between 0.05 and 0.95 to which it has been defined in 994cd0c. Apparently this part of the documentation has not been updated.
  • Loading branch information
jmartens committed Oct 31, 2018
1 parent eec14b7 commit 0e99073
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/starshot_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ A typical analysis sequence looks like so:
* **Analyze the image** -- After loading the image, all that needs to be done is analyze the image. You may optionally
pass in some settings::

mystar.analyze(radius=50, tolerance=0.8) # see API docs for more parameter info
mystar.analyze(radius=0.5, tolerance=0.8) # see API docs for more parameter info

* **View the results** -- Starshot can print out the summary of results to the console as well as draw a matplotlib image to show the
detected radiation lines and wobble circle::
Expand Down

0 comments on commit 0e99073

Please sign in to comment.