ASCEE
/
pyqtgraph
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
pyqtgraph/doc/source/parametertree/parameter.rst

12 lines
282 B
ReStructuredText
Raw Normal View History

Added parametertree documentation
2012-08-17 20:56:12 +00:00
Parameter
=========
Improve parametertree documentation - Increase cross-referencing - Give all built-in parameter and parameter items at least minimal docstring - Start improving coverage of the special options available for some parameters - Organize the built in parameters reference for easier navigation
2021-01-30 18:06:49 +00:00
.. autofunction:: pyqtgraph.parametertree.registerParameterType
Organize paramtypes (#1919) * Registered parameter types go in their own files * Moves [int, float] item definitions outside `WidgetParameterItem` * Moves [int, float] parameter definitions outside `WidgetParameterItem` * Allow registering ParameterItems for easy parameter defs * Finalizes moving simple parameters to their own files * removes accidentally committed file * Provides class qualnames in rst * Address docstring build issues * Address recent review comments - `registerParameterItemType`: * added to docs and parametertree.__init__ * Remove unsed PARAM_TYPES global * Hyperlink to `registerParameterType` - parameter tree rst: * Alphabetize entries * Rebuild RST without fully qualified class name * Add note at file header that it is auto generated * Remove spurious space during rst doc creation * Ensure created/modified files end with newline * Address CodeQL warnings * toPlainText also returns str * `QTreeWidgetItem.text` returns str
2021-08-02 17:47:55 +00:00
.. autofunction:: pyqtgraph.parametertree.registerParameterItemType
Added parametertree documentation
2012-08-17 20:56:12 +00:00
.. autoclass:: pyqtgraph.parametertree.Parameter
:members:
.. automethod:: pyqtgraph.parametertree.Parameter.__init__