Skip to content

Commit 586c2cf

Browse files
committed
refactor: add comment in autoapi_skip_member_fn
1 parent b9851d8 commit 586c2cf

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/source/conf.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,25 @@ def autoapi_skip_member_fn(app, what, name, obj, skip, options) -> bool: # noqa
9494
("method", "datafusion.context.SessionContext.tables"),
9595
("method", "datafusion.dataframe.DataFrame.unnest_column"),
9696
]
97+
# Explicitly skip certain members listed above. These are either
98+
# re-exports, duplicate module-level documentation, deprecated
99+
# API surfaces, or private variables that would otherwise appear
100+
# in the generated docs and cause confusing duplication.
101+
# Keeping this explicit list avoids surprising entries in the
102+
# AutoAPI output and gives us a single place to opt-out items
103+
# when we intentionally hide them from the docs.
97104
if (what, name) in skip_contents:
98105
skip = True
99106

100-
# Skip private members that start with underscore to avoid duplication
107+
# Skip private module-level names (those whose final component
108+
# starts with an underscore) when AutoAPI is rendering data or
109+
# variable entries. Many internal module-level constants are
110+
# implementation details (for example private pyarrow dataset type
111+
# mappings) that would otherwise be emitted as top-level "data"
112+
# or "variable" docs. Filtering them here avoids noisy,
113+
# duplicate, or implementation-specific entries in the public
114+
# documentation while still allowing public members and types to
115+
# be documented normally.
101116
if name.split(".")[-1].startswith("_") and what in ("data", "variable"):
102117
skip = True
103118

0 commit comments

Comments
 (0)