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

docs: reformulate the section on downloading a whole catalog #3170

Merged
merged 2 commits into from
Jan 9, 2025

Conversation

ManonMarchand
Copy link
Member

Hello astroquery 🙂

I think that this reformulation of the section Get a whole catalog might fix the two documentation issues #3167 and #2503

Namely:

  • explicitly say that there is more information on the columns in their description (the content of the tooltips from the webpages)
  • demonstrate the usefulness of row_limit

I also tried to add the idea that downloading a lot of catalogs at once (which was the first example before and now comes a bit later) is a costly operation.

What are your thoughts?

Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.68%. Comparing base (e447461) to head (c9f1b6d).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3170   +/-   ##
=======================================
  Coverage   67.68%   67.68%           
=======================================
  Files         229      229           
  Lines       18365    18365           
=======================================
  Hits        12430    12430           
  Misses       5935     5935           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/vizier/vizier.rst Outdated Show resolved Hide resolved
@keflavich
Copy link
Contributor

The new documentation looks great, thanks!

docs/vizier/vizier.rst Outdated Show resolved Hide resolved
Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

Thank you @ManonMarchand!

@bsipocz bsipocz added this to the v0.4.8 milestone Jan 9, 2025
@bsipocz
Copy link
Member

bsipocz commented Jan 9, 2025

Please feel free to close the issues as you see fit, we can always reopen or do a follow-up if/when more user feedback comes in.

@bsipocz bsipocz merged commit 23d3471 into astropy:main Jan 9, 2025
10 checks passed
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.

3 participants