rattail/tailbone
2
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions

Add docs for MasterView.help_url and get_help_url()

Browse source
This commit is contained in:
Lance Edgar 2018-05-21 15:27:22 -05:00
parent e5ffe3025b
commit db25a5bfd0
2 changed files with 31 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/api/views/master.rst
View file

@ -68,10 +68,21 @@ override when defining your subclass.
Factory callable to be used when creating new grid instances; defaults to
:class:`tailbone.grids.Grid`.
.. Methods to Override
.. -------------------
..
.. The following is a list of methods which you can override when defining your
.. subclass.
..
.. .. automethod:: MasterView.get_settings
.. attribute:: MasterView.help_url
If set, this defines the "default" help URL for all views provided by the
master. Default value for this is simply ``None`` which would mean the
Help button is not shown at all. Note that the master may choose to
override this for certain views, if so that should be done within
:meth:`get_help_url()`.
Methods to Override
-------------------
The following is a list of methods which you can override when defining your
subclass.
.. .. automethod:: MasterView.get_settings
.. automethod:: MasterView.get_help_url