Bug 678 – Documentation for QIODevice is not generated

PySide Bugzilla Closed for New Bugs

PySide is now a Qt Add-on and uses the Qt Project's JIRA Bug Tracker instead of this Bugzilla instance. This Bugzilla is left for reference purposes.

Bug 678 - Documentation for QIODevice is not generated

Summary:

Documentation for QIODevice is not generated

Status:	CLOSED FIXED

Product:	PySide
Classification:	Unclassified
Component:	Documentation
Version:	HEAD
Platform:	All All

Importance:	P3 normal
Assigned To:	renato filho

URL:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2011-02-10 06:27 EET by Thomas Perl
Modified:	2011-02-17 19:18 EET (History)
CC List:	8 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Thomas Perl 2011-02-10 06:27:01 EET

We had a problem on IRC today that a user was trying to use "readData" on
QIODevice, because in the documentation it didn't say what it did:

http://www.pyside.org/docs/pyside/PySide/QtCore/QIODevice.html#PySide.QtCore.QIODevice.readData

However, looking up the documentation in the C++ API docs of Qt, one can see
why this does not work:

http://doc.qt.nokia.com/latest/qiodevice.html#readData

I propose that "readData" gets a proper docstring (probably just copied from
the C++ docs if that's a possibility) so that users reading the docs won't be
irritated by the fact that readData doesn't do what they might expect it does.

Instead of "readData" (which is used by QIODevice internally), "read",
"readAll" or "readLine" should be used (that is, for someone who is *using*
QIODevice, not for subclassing, obviously).

Comment 1 Hugo Parente Lima 2011-02-10 10:59:01 EET

The documentation should be there, but it isn't, prioritizing as P3, thanks for
the report.

Comment 2 Hugo Parente Lima 2011-02-11 15:17:24 EET

The QIODevice doc generation is working, but the docs for beta5 were uploaded
empty to the server.

I'll mark as fixed because I just generated it to fix bug 638 and checket that
it's working.

Comment 3 Hugo Parente Lima 2011-02-17 19:18:24 EET

Released in 1.0.0~rc1