MITLibraries / carbon / 6101279492

94%

push

github

In 905 refine var names and docstrings (#102)

IN-905 Refine code naming conventions and in-code documentation

Why these changes are being introduced:
* Improve code coherency and repo structure

How this addresses that need:
* Rename FTPFeed class to DatabaseToFtpPipe
* Rename FTPReader to FtpFileWriter
* Reorganize app module so classes appear after methods
* Add and update docstrings
* Simplify PipeWriter class
* Additional updates to variable and class names
* Move transform functions to helpers.py
* Deprecate unused context arguments to simplify use

Side effects of this change:
* None

Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/IN-905

145 of 145 new or added lines in 3 files covered. (100.0%)

288 of 293 relevant lines covered (98.29%)

0.98 hits per line