Skip to content

Commit 308d552

Browse files
committed
Update docstring format
1 parent 21eb4ec commit 308d552

7 files changed

+14
-14
lines changed

namedtuple_maker/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env python3
2-
''' Initialization file.
3-
'''
2+
""" Initialization file.
3+
"""
44

55
# nameduple-maker package version
66
__version__ = '1.0.9'

namedtuple_maker/namedtuple_logger.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/usr/bin/env python3
2-
''' Perform logging functions for namedtuple_maker.py
2+
""" Perform logging functions for namedtuple_maker.py
33
44
Requirements:
55
Install Logbook with pip:
@@ -22,7 +22,7 @@
2222
2323
# Step 4, write log events to the log.
2424
app_log.info('Application logging started.')
25-
'''
25+
"""
2626

2727
# Imports - Python Standard Library
2828
from os import path

namedtuple_maker/namedtuple_maker.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/usr/bin/env python3
2-
''' Convert an iterable object into a namedtuple using a decorator.
2+
""" Convert an iterable object into a namedtuple using a decorator.
33
Provide the namedtuple attribute names in a kwarg of the decorated
44
function, or enter attribute names at prompts.
55
@@ -37,7 +37,7 @@ def your_function() -> Iterable:
3737
3838
Example logging target usage:
3939
export LOG_TO_CONSOLE=True
40-
'''
40+
"""
4141

4242
# Imports - Python Standard Library
4343
from collections import namedtuple

namedtuple_maker/namedtuple_utils.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#!/usr/bin/env python3
2-
''' Utility module with functions for the namedtuple-maker application.
2+
""" Utility module with functions for the namedtuple-maker application.
33
44
Usage:
55
See individual function docstrings for usage instructions.
6-
'''
6+
"""
77

88
# Imports - Python Standard Library
99
from os import _exit

setup.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env python3
2-
''' Setup file for packaging.
3-
'''
2+
""" Setup file for packaging.
3+
"""
44

55
# Imports
66
import pathlib

tests/test_namedtuple_logger.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/usr/bin/env pytest
2-
''' pytest tests for namedtuple_logger.py
2+
""" pytest tests for namedtuple_logger.py
33
44
Requires:
55
logbook
@@ -11,7 +11,7 @@
1111
Requires the use of the pytest -s option, to capture console
1212
log output in STDOUT with capfd.
1313
14-
'''
14+
"""
1515

1616
# Imports - Third-Party
1717
from logbook import Logger

tests/test_namedtuple_maker.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#!/usr/bin/env pytest
2-
''' pytest tests for namedtuple_maker.py
2+
""" pytest tests for namedtuple_maker.py
33
44
Usage:
55
pytest tests/test_namedtuple_maker.py
6-
'''
6+
"""
77

88
# Imports - Python Standard Library
99
from collections import namedtuple

0 commit comments

Comments
 (0)