Esa documentation cleanup #1970
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1970 +/- ##
==========================================
- Coverage 62.92% 62.91% -0.02%
==========================================
Files 133 133
Lines 17302 17307 +5
==========================================
+ Hits 10888 10889 +1
- Misses 6414 6418 +4
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
@ceb8 - could you squash the 4th (file deleting commit) into the 3rd one, to avoid the files showing up in the history in the first place? |
Done. |
| @@ -20,15 +20,17 @@ Examples | |||
| 1. Getting Herschel data | |||
| ------------------------ | |||
|
|
|||
| .. doctest-remote-data:: | |||
| .. Skipping becuase of how long the download takes | |||
There was a problem hiding this comment.
I wonder whether it's possible to identify an observation_id that is much smaller, for here and below? cc @jespinosaar
| @@ -82,11 +83,11 @@ Calibration levels can be RAW, CALIBRATED, PRODUCT or AUXILIARY. | |||
|
|
|||
| Note: Artifact is a single Hubble product file. | |||
|
|
|||
| .. code-block:: python | |||
| .. doctest-skip:: | |||
There was a problem hiding this comment.
why skip? add comment or run the code
There was a problem hiding this comment.
It doesn't run, I've marked it as such. @jespinosaar can you replace this with one that does run, or is the file in question just an example?
| @@ -23,15 +21,18 @@ Examples | |||
| 1. Getting XMM-Newton data | |||
| -------------------------- | |||
|
|
|||
| .. code-block:: python | |||
| .. Skipping becuase the download takes too long | |||
| .. doctest-skip:: | |||
There was a problem hiding this comment.
Again, maybe there is a dataset that is minimal at size? cc @jespinosaar
|
|
||
| >>> from astroquery.esa.xmm_newton import XMMNewton | ||
| >>> | ||
| >>> XMMNewton.get_columns('public.v_all_observations') | ||
| >>> XMMNewton.get_columns('xsa.v_all_observations') # doctest: +IGNORE_OUTPUT |
There was a problem hiding this comment.
same, I would rather keep the column list (my rule of thumb: ignore outputs when it's full of floats, and values that are e.g. a result of a truncated SQL query where it's not guaranteed that the same return will be given every time. But keep strings like these column names in for the tests)
|
Let me have a look at your comments @bsipocz, I will look for smaller datasets |
|
OK, so I did one minor cleanup, and as this passes the remote test, going ahead and merge it. I'll open a follow-up issue for using smaller datasets if possible to clean up the remaining example skips. Thanks @ceb8! |
No description provided.