Document _from_c

thecjharries · Mar 17, 2018 · f938b49 · f938b49
1 parent 8ca94fc
commit f938b49
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/pygit2/config.py b/pygit2/config.py
@@ -292,6 +292,10 @@ class ConfigEntry(object):
 
     @classmethod
     def _from_c(cls, ptr, from_iterator=False):
+        """Builds the entry from a ``git_config_entry`` pointer. ``from_iterator``
+        should be ``True`` when the entry was created during ``git_config_iterator``
+        actions
+        """
         entry = cls.__new__(cls)
         entry._entry = ptr
         entry.from_iterator = from_iterator