You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@mahout.apache.org by "viiccwen (via GitHub)" <gi...@apache.org> on 2026/06/07 05:40:55 UTC
[I] [docs] Define QDP Python public API surface for generated docs [mahout]
viiccwen opened a new issue, #1382:
URL: https://github.com/apache/mahout/issues/1382
### What
Define a cleaner public API surface for generated QDP Python API documentation.
The current pydoc-markdown foundation enumerates selected implementation modules and applies a filter to avoid documenting imported helpers and internal symbols. This works for the initial docs pipeline, but the documented API boundary should be made explicit and stable.
### Why
Generated API docs should reflect the public API that users are expected to import and rely on, rather than depending on implementation-module layout or ad hoc filtering rules.
A clearer public surface will make the docs pipeline easier to maintain and reduce accidental exposure of internal backend/helper symbols.
### How
Evaluate and define the QDP Python public API boundary, for example by:
- using package-level exports and `__all__` as the primary public API signal
- documenting which modules/classes/functions should appear in generated API docs
- deciding whether a small docs manifest is needed for generated docs
- updating the pydoc-markdown configuration to rely on the agreed public surface instead of broad module enumeration and filtering
Out of scope:
- changing runtime behavior
- broad website navigation changes
- Rust API documentation generation
---
Related to #1346 and #1361.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@mahout.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [docs] Define QDP Python public API surface for generated docs [mahout]
Posted by "viiccwen (via GitHub)" <gi...@apache.org>.
viiccwen closed issue #1382: [docs] Define QDP Python public API surface for generated docs
URL: https://github.com/apache/mahout/issues/1382
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@mahout.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org