Change the documentation for the new tag_browser_context_action() method so that it is clearer that the method is not required to yield actions.

This commit is contained in:
Charles Haley 2021-07-18 11:05:08 +01:00
parent 5e9798fe9e
commit 76ddbec2cb

View File

@ -354,8 +354,8 @@ class InterfaceAction(QObject):
Called when displaying the context menu in the Tag browser. ``index`` is Called when displaying the context menu in the Tag browser. ``index`` is
the QModelIndex that points to the Tag browser item that was right clicked. the QModelIndex that points to the Tag browser item that was right clicked.
Test it for validity with index.valid() and get the underlying TagTreeItem Test it for validity with index.valid() and get the underlying TagTreeItem
object with index.data(Qt.ItemDataRole.UserRole). This method must yield one object with index.data(Qt.ItemDataRole.UserRole). Any action objects
or more action objects that will be added to the context menu. yielded by this method will be added to the context menu.
''' '''
if False: if False:
yield QAction() yield QAction()