Details
-
Type:
User Story
-
Status: Open
-
Priority:
P2: Important
-
Resolution: Unresolved
-
Affects Version/s: 5.9, 5.11.0, dev
-
Fix Version/s: None
-
Component/s: Documentation
-
Labels:None
Description
The generated documentation include code from Qt.
Some of this code has been translated to Python, and it is currently placed in:
sources/pyside2/doc/codesnippets/doc/src/snippets/
Still, there are a few things to be addressed:
- Verify if all the Python code portions works
- Translate all the C++ references to Python
- Exclude the elements that we are not using, e.g.: QList<String> exists only as a Python string list, but we currently have documentation about it.
Additionally, some functions needs extra explanation, like QObject.findChild/find.Children and return types that are described as a python type that is not clear, e.g.: PyTuple.
Attachments
Issue Links
- is required for
-
PYSIDE-363 Fix documentation generation
-
- Closed
-
Gerrit Reviews
For Gerrit Dashboard: PYSIDE-691 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
273052,8 | WIP: Corrects the snippets for the docs for PySide multimedia | 5.13.2 | pyside/pyside-setup | Status: NEW | -2 | 0 |
274130,3 | Docs: separate snippets into standalone files | 5.14 | qt/qtbase | Status: NEW | -1 | 0 |
328648,15 | Long live snippets_translate! | dev | pyside/pyside-setup | Status: NEW | +1 | 0 |