GAIA: Astroquery documentation: general update [ci skip]#2969
Conversation
bsipocz
left a comment
There was a problem hiding this comment.
The RTD failures are unrelated, so this looks good pending a small very minor things.
In the meantime I noticed that most of the file has examples with skipped tests. Some of that makes sense (logins, uploaded tables, etc), but I think some could be included in testing, as a topic for a future PR (so the doctest-skip-all directive could be revised to ensure later parts are picked up for testing).
| i.e.: *user_<your_login_name>.t<job_id>*):: | ||
|
|
||
| >>> full_qualified_table_name = 'user_<your_login_name>.t1539932994481O' | ||
| >>> full_qualified_table_name = 'user_<your_login_name>."t1710251325268O"' |
There was a problem hiding this comment.
this looks weird, the "s are not in the table name in the narrative text in the line above
There was a problem hiding this comment.
This is required if the user wants to use a table name that contains capital letters. Otherwise, an error would be thrown. This is due to the TAP implementation at ESAC.
There was a problem hiding this comment.
My point is that the docs above says user_<your_login_name>.t<job_id>, without the quotation marks rather than user_<your_login_name>."t<job_id>", so which one is it? If the latter, then the narrative above needs to be changed, too
There was a problem hiding this comment.
@bsipocz, I see now what you mean. I've updated the text including the text user_<your_login_name>."t<job_id>" as well as a small explanation.
…le name t1710251325268O
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2969 +/- ##
==========================================
+ Coverage 66.80% 66.81% +0.01%
==========================================
Files 237 237
Lines 18321 18323 +2
==========================================
+ Hits 12239 12243 +4
+ Misses 6082 6080 -2 ☔ View full report in Codecov by Sentry. |
…le name t1710251325268O
…o ESA_gaia_update_documentation
We would like include some minor changes in the gaia documentation.
cc @esdc-esac-esa-int
Jira GAIAMNGT-1632