Skip to content

Commit

Permalink
pdoc annotations to control auto-docs (#270)
Browse files Browse the repository at this point in the history
  • Loading branch information
hemidactylus authored Mar 28, 2024
1 parent d5931f9 commit 6717f25
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 0 deletions.
9 changes: 9 additions & 0 deletions astrapy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,12 @@ def get_version() -> str:
"DataAPIClient",
"__version__",
]


__pdoc__ = {
"api": False,
"core": False,
"db": False,
"ops": False,
"ids": False,
}
5 changes: 5 additions & 0 deletions astrapy/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,8 @@ def __init__(self) -> None:
UUIDV6 = "uuidv6"
UUIDV7 = "uuidv7"
DEFAULT = "uuid"


__pdoc__ = {
"normalize_optional_projection": False,
}
7 changes: 7 additions & 0 deletions astrapy/exceptions.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}

0 comments on commit 6717f25

Please sign in to comment.