Update the guide docstrings to talk more about the algorithm #225
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This isn't sphinx perfect. |
taldcroft
reviewed
Jan 4, 2019
proseco/guide.py
Outdated
| @@ -64,6 +64,8 @@ def get_guide_catalog(obsid=0, **kwargs): | |||
|
|
|||
|
|
|||
| class GuideTable(ACACatalogTable): | |||
| # Catalog type when plotting (None | 'FID' | 'ACQ' | 'GUI') | |||
There was a problem hiding this comment.
Here and elsewhere there are code changes that are part of #221, so I'm confused. I just tried rebasing on master and that went smoothly, so you should do that.
jeanconn
force-pushed
the
guide_more_docstrings
branch
from
cb63742
to
58bde0f
Compare
jeanconn
commented
Jan 4, 2019
taldcroft
approved these changes
Aug 10, 2019
proseco/guide.py
Outdated
| stars in the stages. | ||
| Run search stages as necessary to select up to the requested number of guide stars. | ||
|
|
||
| This routine first force selects any guide stars supplied as 'include_ids', marking |
There was a problem hiding this comment.
Use double back-ticks for literals or variable names.
proseco/guide.py
Outdated
| stage requirements are marked with the allowed stage of selection (by its integer id) | ||
| in the 'stage' column in the candidate table. | ||
|
|
||
| The run_search_stages method loops over the search stages until at least the n |
There was a problem hiding this comment.
.. at least the ``n_guide`` ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the guide docstrings to talk more about the algorithm