GAIA: Update the information for the returned value in the docstring of the function cross_match. #2937
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
…o correct typos in the docstring of the function get_datalinks
cosmoJFH
changed the title
cosmoJFH
changed the title
bsipocz
approved these changes
Jan 30, 2024
CHANGES.rst
Outdated
| @@ -49,6 +49,8 @@ gaia | |||
|
|
|||
| - The method ``get_datalinks`` can be used with the new parameter linking_parameter. It completes PR #2859. [#2936] | |||
|
|
|||
| - Update the docstring for the returned value of the method ``cross_match``. [#2937] | |||
There was a problem hiding this comment.
no need for changelog for docs related changes. (the need for documenting changelog howto has already raised, so I'll try to write it up sometimes soon.)
bsipocz
force-pushed
the
ESA_gaia_update_docstring
branch
from
bf6b17c
to
b4c1492
Compare
|
Thanks @cosmoJFH! |
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.
We would like to update the docstring of the function
cross_match. The description of the returned valueBoolean indicating if the specified user is validshould be changed to
A Job objectcc @esdc-esac-esa-int