In 905 refine var names and docstrings #102
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 * Rename PipeWriter.pipe to PipeWriter.connect * Reorganize app module so classes appear after methods * Add docstrings to cli and app modules Side effects of this change: * None Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/IN-905
ehanson8
reviewed
Sep 5, 2023
* Add and update docstrings * Simplify PipeWriter class * Additional updates to variable and class names * Move transform functions to helpers.py
jonavellecuerdo
force-pushed
the
IN-905-refine-var-names-and-docstrings
branch
3 times, most recently
from
ce57328 to
6f2f943
Compare
|
@ehanson8 Please see the latest commit! For minor comments, I marked them as 'resolved' as I worked through the changes, but I left the open-ended ones that still need you review. Let me know what you think. :) |
ehanson8
approved these changes
Sep 6, 2023
jonavellecuerdo
force-pushed
the
IN-905-refine-var-names-and-docstrings
branch
from
6f2f943 to
5c63810
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Refine code naming conventions and in-code documentation to improve code coherency and repo
structure.
How can a reviewer manually see the effects of these changes?
Review PR and examine if added/updated docstrings and code naming conventions are informative
or helpful in explaining the app's workflow.
Includes new or updated dependencies?
NO
Developer
Code Reviewer
(not just this pull request message)