viiccwen opened a new pull request, #1456: URL: https://github.com/apache/mahout/pull/1456
### Related Issues Part of #1358 Related to #1361 ### Changes - [ ] Bug fix - [ ] New feature - [ ] Refactoring - [x] Documentation - [ ] Test - [ ] CI/CD pipeline - [ ] Other ### Why QDP source docstrings contain reStructuredText roles and unfenced usage examples that do not render cleanly in the generated Docusaurus API reference. This causes references such as `:meth:` and `:class:` to appear literally and makes Python usage examples harder to distinguish from surrounding prose. ### How - Replace reStructuredText roles with Markdown-compatible inline code in QDP docstrings. - Wrap the `QdpBenchmark` usage example in a fenced Python code block. - Wrap the `QuantumDataLoader` usage example in a fenced Python code block. - Keep the changes documentation-only without modifying runtime behavior or the public API surface. The changes are limited to: - `qdp/qdp-python/qumat_qdp/_backend.py` - `qdp/qdp-python/qumat_qdp/api.py` - `qdp/qdp-python/qumat_qdp/loader.py` - `qdp/qdp-python/qumat_qdp/tensor.py` ### Validation - Generated the QDP Python API reference with `pydoc-markdown`. - Confirmed the usage examples render as Python code blocks. - Confirmed reStructuredText role markers no longer appear in the generated Markdown. - Existing QDP Python tests: 7 passed, 6 skipped because the native extension was not built. ## Checklist - [ ] Added or updated unit tests for all changes — not applicable; documentation-only change - [x] Added or updated documentation for all changes -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
