This project has moved and is read-only. For the latest updates, please go here.

Intellsense tooltips handling Sphinx/reST?

Oct 10, 2014 at 2:07 PM
Edited Oct 10, 2014 at 2:08 PM
Are there any plans to add support for Sphinx-style reST docstrings? For example, given the following docstring, I'd expect to have the tooltip be able to reformat the different function parameters and bold them as I type each one, like is done for C++ and C#.
Adds a menu to the control containing the specified items. Each item
in the menu sets the specified attribute on the input node to its
value when selected, and calls the callback callable (if specified).

The menu created is a right-click, context popup menu, unless the
control is an optionMenu, in which case the menu items are added
directly to the control.
:param control: the control to add the menu to
:type control: a Maya UI type that supports menus
:param node: the Maya node whose attribute is set by the menu
:type node: a Maya node type
:param attrName: the name of the attribute to set on the node
:type attrName: string
:param items: the names of the menus to create
:type items: a list of strings
:param callback: a callable that will be called when a menu item is selected
:type callback: callable taking the node, the attribute name, and the new value
Oct 10, 2014 at 4:17 PM
There's a vague hope that one day we can do this :)

It really depends on resourcing. I started something a while back but we didn't have time to finish it and haven't had time since to go back to it - it's issue 1928 in our issue tracker if you want to vote/follow.

The format used by numpy/scipy is more likely to be done first, as we have a lot of users using those libraries and their docstrings are very consistent, but my ambition is to have a good set of heuristics for handling a range of docstrings.