[Solved]The issue of PySide class reference documentation



  • All the lines that start with line numbers in Qt documentation for C++ are missing in The PySide class reference documentation.

    here is an example :
    https://deptinfo-ensip.univ-poitiers.fr/ENS/pyside-docs/PySide/QtGui/QMessageBox.html?highlight=qmessagebox.about#PySide.QtGui.PySide.QtGui.QMessageBox.about

    where is the four locations ???
    .



  • I looked up the Qt 4.8 API documentation for C++ and found this page:

    "QMessageBox Class Reference":http://qt-project.org/doc/qt-4.8/qmessagebox.html

    If you search the page for about() looks for a suitable icon in four locations, it should take you to the four locations.



  • I think the PySide documentation is generated automatically (without human editors) from the C++ version of the documentation (which I assume does have human editors, but probably the C++ documentation is kept version controlled IN the source code.)

    So you are reporting a deficiency in that automatic documentation generation: "numbered lists in the html" are missing. I suspect it won't be soon fixed.

    As Indn says, it is relatively easy to read the C++ documentation. I code in Python, but read the C++ documentation.



  • but anyone knows how to report this bug ?


  • Lifetime Qt Champion

    Hi,

    You could try to ask on the #pyside channel. Somebody might be able to tell you that there faster



  • Expounding on SGaist's reply....

    Usually a project such as PySide has an IRC channel. Some of the key developers usually hang out on (monitor) that channel. (Although it can get clogged with hanger's on, who don't contribute much.) Usually the channel is for people who are willing to attempt to fix a bug, or otherwise contribute documentation or source code.

    You shouldn't report bugs on the IRC channel.

    You must be polite. Don't ask trivial questions that you could answer yourself by browsing the source code (although you can ask where to begin looking.) If you do ask a question, just come right out and ask it as simply and briefly as you can. No need to explain why you want to know, or to introduce yourself.

    In this case, it MIGHT be fair to ask "Where should I report a bug in the PySide documentation." At this point I think it is already clear that it is a bug (and since it is in the documentation, relatively low priority for most developers, except for the one developer who might be in charge of the documentation.) If you ask, "Isn't this a bug?", it might be received as a complaint. It might be better if you are willing to attempt to fix the bug and ask "Where is the code that generates PySide documentation."

    I could be wrong, I am speaking from my limited experience with the Gimp project. I have no experience with the PySide project or channel.

    "But isn't this where you should report the bug?":https://bugreports.qt-project.org/browse/PYSIDE



  • thanks for your tips !!!
    [quote author="bootchk" date="1365163715"]Expounding on SGaist's reply.... Usually a project such as PySide has an IRC channel. Some of the key developers usually hang out on (monitor) that channel. (Although it can get clogged with hanger's on, who don't contribute much.) Usually the channel is for people who are willing to attempt to fix a bug, or otherwise contribute documentation or source code. You shouldn't report bugs on the IRC channel. You must be polite. Don't ask trivial questions that you could answer yourself by browsing the source code (although you can ask where to begin looking.) If you do ask a question, just come right out and ask it as simply and briefly as you can. No need to explain why you want to know, or to introduce yourself. In this case, it MIGHT be fair to ask "Where should I report a bug in the PySide documentation." At this point I think it is already clear that it is a bug (and since it is in the documentation, relatively low priority for most developers, except for the one developer who might be in charge of the documentation.) If you ask, "Isn't this a bug?", it might be received as a complaint. It might be better if you are willing to attempt to fix the bug and ask "Where is the code that generates PySide documentation." I could be wrong, I am speaking from my limited experience with the Gimp project. I have no experience with the PySide project or channel. "But isn't this where you should report the bug?":https://bugreports.qt-project.org/browse/PYSIDE[/quote]


Log in to reply
 

Looks like your connection to Qt Forum was lost, please wait while we try to reconnect.