Bug 330 – Generated documentation still refers to QStrings

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 330 - Generated documentation still refers to QStrings

Summary:

Generated documentation still refers to QStrings

Status:	CLOSED FIXED

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

Importance:	P5 normal
Assigned To:	renato filho

URL:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2010-08-31 12:14 EEST by Matti Airas
Modified:	2010-10-13 13:48 EEST (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 Matti Airas 2010-08-31 12:14:21 EEST

The reference documentation is full of QStrings (instead of unicodes).

Comment 1 Matti Airas 2010-08-31 12:21:13 EEST

Also QLists, and apparently the return values are not displayed correctly when
the original C++ function returns values via pointer/reference arguments and
the respective PySide function returns a tuple. E.g.
QFileDialog.getOpenFileNames.

... or is the return value case sufficiently different to warrant a bug of its
own?

Comment 2 Hugo Parente Lima 2010-09-23 16:23:14 EEST

Fixed in commit
generatorrunner/00ef2994b4cb744173f92d57673683a7d2d0b0c3

Comment 3 Matti Airas 2010-09-27 07:45:52 EEST

Pre-API2 types still prevalent in the docs, e.g.

http://www.pyside.org/docs/pyside/PySide/QtGui/QFileDialog.html#PySide.QtGui.QFileDialog.getOpenFileName

http://www.pyside.org/docs/pyside/PySide/QtCore/QSettings.html#PySide.QtCore.QSettings.value

Reopening.

Comment 4 Hugo Parente Lima 2010-09-30 14:55:39 EEST

Finally fixed in commits:

commit 69566068b5d0e3fa9f21f038dc7622cf1d9b3594
Author: Hugo Parente Lima <hugo.pl@gmail.com>
Date:   Mon Sep 27 14:50:52 2010 -0300

    Replace QVariant doc entries by None or object.

    None when QVariant is used as an argument default value, object
    when it's used as return value or just to inform the expected
    argument type.

commit 23979df5d6e9d4dfcdcaef8f4c358cb2acd721c5
Author: Hugo Parente Lima <hugo.pl@gmail.com>
Date:   Mon Sep 27 14:44:36 2010 -0300

    Support doc generation of various modules in one go and removes QString and
QStringList entries from generated docs.


The docs for PySide 0.4.1 still with QStrings, the fix will be available only
to docs of 0.4.2 and beyond.

Comment 5 renato filho 2010-10-13 13:48:30 EEST

released on PySide 0.4.2