openstack/deb-python-pygit2
Code Issues Proposed changes

Fix config documentation keyword

Browse Source 
The keyword for linking to a mehtod is 'meth', not 'method'. Setting the
'currentmodule' allows us to link without the 'pygit2' prefix in the
link text.
This commit is contained in:
Carlos Martín Nieto 2014-04-18 12:17:54 +02:00
parent 397e8ad07c
commit 4c4968a2fb
1 changed files with 3 additions and 1 deletions

4
docs/config.rst

@ -22,11 +22,13 @@ The Config type
aware that this may return multiple versions of each entry if they are aware that this may return multiple versions of each entry if they are
set multiple times in the configuration files. set multiple times in the configuration files.
.. currentmodule:: pygit2
The :class:`Config` Mapping interface. The :class:`Config` Mapping interface.
When using the mapping interface, the value is returned as a When using the mapping interface, the value is returned as a
string. In order to apply the git-config parsing rules, you can use string. In order to apply the git-config parsing rules, you can use
:method:`Config.get_bool` or :method:`Config.get_int`. :meth:`Config.get_bool` or :meth:`Config.get_int`.
.. automethod:: pygit2.Config.get_bool .. automethod:: pygit2.Config.get_bool
.. automethod:: pygit2.Config.get_int .. automethod:: pygit2.Config.get_int