Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable testing examples in Gaia documentation #2283

Merged
merged 2 commits into from
Feb 15, 2022

Conversation

eerovaher
Copy link
Member

@eerovaher eerovaher commented Feb 4, 2022

The work done in #1973 that started enabling testing the code examples in Gaia documentation is finalized here. The examples that do not produce files and do not require logging in to the archive can now be tested.

EDIT: Contributes towards #854.

@codecov
Copy link

codecov bot commented Feb 4, 2022

Codecov Report

Merging #2283 (8303747) into main (27515e4) will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2283      +/-   ##
==========================================
+ Coverage   62.72%   62.74%   +0.01%     
==========================================
  Files         131      130       -1     
  Lines       16854    16837      -17     
==========================================
- Hits        10572    10564       -8     
+ Misses       6282     6273       -9     
Impacted Files Coverage Δ
astroquery/mast/cloud.py 22.07% <0.00%> (-0.59%) ⬇️
astroquery/utils/testing_tools.py

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 27515e4...8303747. Read the comment docs.

@ceb8 ceb8 added this to the v0.4.6 milestone Feb 13, 2022
@ceb8 ceb8 added the gaia label Feb 13, 2022
Copy link
Member

@ceb8 ceb8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The testing part looks good. However, you've removed all import statements except those at the top, please put them back. The user needs to know what to import no matter where they jump into the documentation.

The code examples in `Gaia` module documentation that do not require the
user to log into the archive and that do not produce leftover files can
now be tested.
@bsipocz
Copy link
Member

bsipocz commented Feb 15, 2022

Thanks @eerovaher!

@bsipocz bsipocz merged commit 5740dc7 into astropy:main Feb 15, 2022
@eerovaher eerovaher deleted the gaia-doc-cleanup2 branch February 28, 2022 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants