panda3d-docs icon indicating copy to clipboard operation
panda3d-docs copied to clipboard

Variables, Enums, etc. in the API

Open ArsThaumaturgis opened this issue 5 years ago • 2 comments

Right now, API entries seem to include methods, but not variables, enums, and the like.

The manual does document at least some of these--but not exhaustively, I think. And furthermore, in some cases it may be easier to find an appropriate reference page by examining the expected containing class than by guessing at where in the manual a desired value might be mentioned.

Thus, since such variables, enums, and the like can, I think, be quite useful and even important, I suggest that they be added alongside methods in the API reference.

ArsThaumaturgis avatar May 11 '20 15:05 ArsThaumaturgis

I do see enums: https://docs.panda3d.org/1.10/python/reference/panda3d.core.NodePath#_CPPv49ErrorType

Is there a page where you are missing one? Or perhaps there is something about the way they are shown that makes them hard to find?

rdb avatar May 11 '20 15:05 rdb

Hmm, you're right. (Although looking at that page prompts another thought for an enhancement...)

That said, one example might be DirectGuiGlobals: I see none of the state, style, event, etc. values defined there.

ArsThaumaturgis avatar May 11 '20 15:05 ArsThaumaturgis