Mercurial > gnulib
changeset 38968:95aacb6c496f
update documentation strings
| author | Dmitry Selyutin <ghostmansd@gmail.com> |
|---|---|
| date | Fri, 15 Sep 2017 23:11:14 +0300 |
| parents | a15d642a41c2 |
| children | 0df402379e3e |
| files | pygnulib/config.py pygnulib/error.py pygnulib/filesystem.py pygnulib/generator.py pygnulib/module.py pygnulib/parser.py |
| diffstat | 6 files changed, 11 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/pygnulib/config.py Fri Sep 15 22:51:21 2017 +0300 +++ b/pygnulib/config.py Fri Sep 15 23:11:14 2017 +0300 @@ -1,5 +1,6 @@ #!/usr/bin/python # encoding: UTF-8 +"""gnulib configuration API"""
--- a/pygnulib/error.py Fri Sep 15 22:51:21 2017 +0300 +++ b/pygnulib/error.py Fri Sep 15 23:11:14 2017 +0300 @@ -1,5 +1,6 @@ #!/usr/bin/python # encoding: UTF-8 +"""gnulib miscellaneous error classes""" @@ -30,6 +31,7 @@ class CommandLineError(Exception): + """command-line parsing error""" def __init__(self, program, message): super().__init__("{0}: {1}".format(program, message))
--- a/pygnulib/filesystem.py Fri Sep 15 22:51:21 2017 +0300 +++ b/pygnulib/filesystem.py Fri Sep 15 23:11:14 2017 +0300 @@ -1,5 +1,6 @@ #!/usr/bin/python # encoding: UTF-8 +"""gnulib virtual filesystem API""" @@ -72,6 +73,7 @@ @property def name(self): + """directory name""" return self.__name
--- a/pygnulib/generator.py Fri Sep 15 22:51:21 2017 +0300 +++ b/pygnulib/generator.py Fri Sep 15 23:11:14 2017 +0300 @@ -1,5 +1,6 @@ #!/usr/bin/python # encoding: UTF-8 +"""gnulib generators API"""
--- a/pygnulib/module.py Fri Sep 15 22:51:21 2017 +0300 +++ b/pygnulib/module.py Fri Sep 15 23:11:14 2017 +0300 @@ -1,5 +1,6 @@ #!/usr/bin/python # encoding: UTF-8 +"""gnulib module API""" @@ -297,17 +298,17 @@ def items(self): - """a set-like object providing a view on configuration items""" + """a set-like object providing a view on module items""" return self.__table.items() def keys(self): - """a set-like object providing a view on configuration keys""" + """a set-like object providing a view on module keys""" return self.__table.keys() def values(self): - """a set-like object providing a view on configuration values""" + """a set-like object providing a view on module values""" return self.__table.values()