From a5a8df8aaa037b18fb38f6ddfbf1b2e245a459c6 Mon Sep 17 00:00:00 2001 From: Sean McGuire Date: Mon, 29 Jan 2024 17:37:13 -0500 Subject: [PATCH] add class docstring --- src/hipscat/catalog/margin_cache/margin_catalog.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/hipscat/catalog/margin_cache/margin_catalog.py b/src/hipscat/catalog/margin_cache/margin_catalog.py index cc7db8d8..743f9460 100644 --- a/src/hipscat/catalog/margin_cache/margin_catalog.py +++ b/src/hipscat/catalog/margin_cache/margin_catalog.py @@ -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