Skip to content

Commit

Permalink
add class docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
smcguire-cmu committed Jan 29, 2024
1 parent 63d1622 commit a5a8df8
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/hipscat/catalog/margin_cache/margin_catalog.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,12 @@


class MarginCatalog(HealpixDataset):
"""
"""A HiPSCat Catalog used to contain the 'margin' of another HiPSCat catalog.
Catalogs of this type are used alongside a primary catalog, and contains the margin points for each
HEALPix pixel - any points that are within a certain distance from the HEALPix pixel boundary. This is
used to ensure spatial operations such as crossmatching can be performed efficiently while maintaining
accuracy.
"""
# Update CatalogInfoClass, used to check if the catalog_info is the correct type, and
# set the catalog info to the correct type
Expand Down

0 comments on commit a5a8df8

Please sign in to comment.