Bug 168 – API documentation suggestions

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 168 - API documentation suggestions

Summary:

API documentation suggestions

Status:	CLOSED FIXED

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

Importance:	P5 enhancement
Assigned To:	renato filho

URL:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2010-02-23 21:17 EET by gt6
Modified:	2010-10-13 13:48 EEST (History)
CC List:	6 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 gt6 2010-02-23 21:17:34 EET

Just two small things that I'd think would greatly improve the API
documentation website:

1) Make the page titles display the class name _first_. E.g. instead of having
a title like this:

"PySide - QLineEdit"

make it like this:

"QLineEdit - PySide"

This makes browsing the API much easier if the user is using a tabbed browser
with narrow tabs. For example I only see "Pyside -" on all the tabs which makes
fast tab switching between docs a nuisance.

2) Link argument types! For example, on
http://www.pyside.org/docs/pyside/PySide/QtGui/QCheckBox.html#PySide.QtGui.QCheckBox.setCheckState
there is:

QCheckBox.setCheckState(state)
    Parameter:    state – CheckState

Make the "CheckState" a link to the "QtCore.Qt.Checked" reference just like the
C++ API docs are doing it:
http://doc.trolltech.com/4.2/qcheckbox.html#setCheckState

Comment 1 Hugo Parente Lima 2010-07-07 18:12:16 EEST

Change #1 has been applied, although change #2 requires more work.

Comment 2 Hugo Parente Lima 2010-09-24 16:15:13 EEST

Fixed in commit
pyside/3e0af488ee5820f35462f381c5a1676dc9560a5d
generator/00ef2994b4cb744173f92d57673683a7d2d0b0c3

Comment 3 renato filho 2010-10-13 13:48:20 EEST

released on PySide 0.4.2