search

astronomy-commons / hipscat-import

HiPSCat import - generate HiPSCat-partitioned catalogs
https://hipscat-import.readthedocs.io
BSD 3-Clause "New" or "Revised" License
5 stars 3 forks source link

Expand docs for margin and index generation. #212

Closed delucchi-cmu closed 7 months ago

delucchi-cmu commented 7 months ago

Change Description

Gives all the help I can think to give when generating margin caches or index tables.

Note that this duplicates A LOT of the text between catalogs/arguments.rst, guide/margin_cache.rst and guide/index_table.rst. This is intentional, and based on feedback I got from Troy about duplicating some argument specifications instead of making users look in a few different places to put their pipeline together.

delucchi-cmu commented 7 months ago

Docs previews:

https://hipscat-import--212.org.readthedocs.build/en/212/guide/margin_cache.html https://hipscat-import--212.org.readthedocs.build/en/212/guide/index_table.html

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (4a2d119) 99.74% compared to head (239fa7f) 99.74%. Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #212 +/- ## ======================================= Coverage 99.74% 99.74% ======================================= Files 24 24 Lines 1186 1186 ======================================= Hits 1183 1183 Misses 3 3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.