ShowBase documentation lacks proper return types and other details

Bug #1424248 reported by ellie
18
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Panda3D
Fix Released
Undecided
Unassigned

Bug Description

The ShowBase class is very central for people not using the DirectStart hack. Sadly, the documentation appears to be rather abysmal:

https://www.panda3d.org/reference/devel/python/classshowbase.ShowBase.ShowBase.php#a3b51c79a7f111d2be9d347ac9bfe3abd

None of the return types are properly specified, and there's almost no descriptive text either. At least the return types should be consistently specified.

Example:

E.g. what are win and winList? A reference to the main window and list of windows? But what do I get back, an id, a class instance (what class?), a list, an iterator, a HWND, ..? It's pretty much useless without any return type details and at least a short sentence on what it does.

Tags: docs
Revision history for this message
ellie (et1234567) wrote :

Also, central things like "render2d" should definitely have a working link to the page on the documentation describing that component in more detail.

Moguri (mogurijin)
tags: added: docs
Revision history for this message
rdb (rdb) wrote :
Changed in panda3d:
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.