From 23fd9b542e62b7d3ab8399afab9f75be3f3057a5 Mon Sep 17 00:00:00 2001 From: Stefano Lottini Date: Thu, 28 Mar 2024 16:06:06 +0100 Subject: [PATCH] pdoc annotations to control auto-docs --- astrapy/__init__.py | 9 +++++++++ astrapy/constants.py | 5 +++++ astrapy/exceptions.py | 7 +++++++ 3 files changed, 21 insertions(+) diff --git a/astrapy/__init__.py b/astrapy/__init__.py index 1fe92442..ed958231 100644 --- a/astrapy/__init__.py +++ b/astrapy/__init__.py @@ -79,3 +79,12 @@ def get_version() -> str: "DataAPIClient", "__version__", ] + + +__pdoc__ = { + "api": False, + "core": False, + "db": False, + "ops": False, + "ids": False, +} diff --git a/astrapy/constants.py b/astrapy/constants.py index 3523c900..3d05a146 100644 --- a/astrapy/constants.py +++ b/astrapy/constants.py @@ -102,3 +102,8 @@ def __init__(self) -> None: UUIDV6 = "uuidv6" UUIDV7 = "uuidv7" DEFAULT = "uuid" + + +__pdoc__ = { + "normalize_optional_projection": False, +} diff --git a/astrapy/exceptions.py b/astrapy/exceptions.py index e0a477dc..661dbd50 100644 --- a/astrapy/exceptions.py +++ b/astrapy/exceptions.py @@ -785,3 +785,10 @@ def remaining_timeout_info(self) -> Union[TimeoutInfo, None]: for use within the multi-call method. """ return base_timeout_info(max_time_ms=self.remaining_timeout_ms()) + + +__pdoc__ = { + "base_timeout_info": False, + "to_dataapi_timeout_exception": False, + "MultiCallTimeoutManager": False, +}