openstack/deb-python-pygit2
Code Issues Proposed changes

Correct LIBGIT2_VERSION name and add documentation

Browse Source 
LIBGIT2_VERSION was previously recorded as LIBGIT2_VER_VERSION which is
incorrect.

We also add basic explanations to all the constants so that the page is
a little less bare. Perhaps this should be done as autodoc style
comments in the code but I guess not.
This commit is contained in:
Michael Jones
2014-06-08 19:23:13 +01:00
parent 95e6593625
commit bd322fa132
1 changed files with 36 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/general.rst
View File

@@ -6,14 +6,45 @@ General
:local:
Top level constants and exceptions from the library.
Constants
=========
.. py:data:: LIBGIT2_VER_MAJOR
.. py:data:: LIBGIT2_VER_MINOR
.. py:data:: LIBGIT2_VER_REVISION
.. py:data:: LIBGIT2_VER_VERSION
The following constants provide information about the version of the libgit2
library that has been built against. The version number has a
``MAJOR.MINOR.REVISION`` format.
.. py:data:: LIBGIT2_VER_MAJOR
Integer value of the major version number. For example, for the version
``0.20.0``::
>>> print LIBGIT2_VER_MAJOR
0
.. py:data:: LIBGIT2_VER_MINOR
Integer value of the minor version number. For example, for the version
``0.20.0``::
>>> print LIBGIT2_VER_MINOR
20
.. py:data:: LIBGIT2_VER_REVISION
Integer value of the revision version number. For example, for the version
``0.20.0``::
>>> print LIBGIT2_VER_REVISION
0
.. py:data:: LIBGIT2_VERSION
The libgit2 version number as a string::
>>> print LIBGIT2_VERSION
'0.20.0'
Errors
======
@@ -22,3 +53,4 @@ Errors
:members:
:show-inheritance:
:undoc-members: