Update documentation for the gaia query object (#1760) #1871
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1871 +/- ##
==========================================
- Coverage 64.44% 64.44% -0.01%
==========================================
Files 200 200
Lines 15962 15961 -1
==========================================
- Hits 10287 10286 -1
Misses 5675 5675
Continue to review full report at Codecov.
|
CHANGES.rst
Outdated
| @@ -81,6 +81,9 @@ alma | |||
|
|
|||
| gaia | |||
| ^^^^ | |||
|
|
|||
| - Update documentation to show how to control the number of rows returned by | |||
There was a problem hiding this comment.
Please remove the changelog
a rule of thumb is that there is no need for a changelog for changes to the docs, or internals that has non direct effect on user facing behaviour.
docs/gaia/gaia.rst
Outdated
| 0.021615117161838747 1635721458409799680 ... | ||
| Length = 50 rows | ||
|
|
||
| The query returns a result containing 50 rows by default. The number of rows returned can be controlled by setting ``Gaia.ROW_LIMIT`` appropriately. |
There was a problem hiding this comment.
Maybe factor out the default value as if it changes, it's difficult to catch in the narrative docs
| The query returns a result containing 50 rows by default. The number of rows returned can be controlled by setting ``Gaia.ROW_LIMIT`` appropriately. | |
| Queries return a limited number of rows controlled by ``Gaia.ROW_LIMIT``. To change the default behaviour set this appropriately. |
| 0.005846434715822121 1635721458409799680 ... | ||
| 0.006209042666371929 1635721458409799680 ... | ||
| 0.007469463683838576 1635721458409799680 ... | ||
| 0.008202004514524316 1635721458409799680 ... | ||
|
|
There was a problem hiding this comment.
Maybe add an additional example for unlimited number of rows.
E.g. work the test from here: https://github.com/astropy/astroquery/blob/master/astroquery/gaia/tests/test_gaia_remote.py#L24 into an example
|
Thank you @mfonism! |
This PR updates the gaia docs to show how to control the number of rows returned by the gaia query object as per #1760.
It also updates the examples in the docs to match the default behaviours.