Skip to content

Commit

Permalink
Added module docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
jwodder committed Jan 27, 2017
1 parent f72fe30 commit aae2a41
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
2 changes: 0 additions & 2 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
- Add docstrings
- Add a module docstring (Include link to GitHub repo)
- Create a Readthedocs site?
- Somewhere document exactly how the module works with regards to creating
temporary files and moving things around
Expand Down
16 changes: 15 additions & 1 deletion inplace.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
"""
In-place file processing
The ``inplace`` module provides Python classes for reading & writing a file
"in-place": data that you write ends up at the same filepath that you read
from, and ``inplace`` takes care of all the necessary mucking about with
temporary files for you.
Visit <https://github.com/jwodder/inplace> for more information.
"""

__version__ = '0.1.0.dev1'
__author__ = 'John Thorvald Wodder II'
__author_email__ = '[email protected]'
Expand Down Expand Up @@ -174,7 +185,10 @@ def open_write(self, path):
pass

def _close(self):
""" Close filehandles and set them to `None` """
"""
Close filehandles (if they aren't closed already) and set them to
`None`
"""
if self.input is not None:
self.input.close()
self.input = None
Expand Down

0 comments on commit aae2a41

Please sign in to comment.