Minor refactoring of docstring formatting in preprocess_data #10191
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
tacaswell
approved these changes
Jan 7, 2018
dstansby
reviewed
Jan 8, 2018
| @@ -1545,6 +1545,41 @@ def _replacer(data, key): | |||
| """ | |||
|
|
|||
|
|
|||
| def _add_data_doc(docstring, replace_names, replace_all_args): | |||
There was a problem hiding this comment.
Shouldn't these be keyword arguments if they're optional? (ie. docstring, replace_names=None, replace_all_args=False)
There was a problem hiding this comment.
No. This is just a private helper function which does not need the flexibility of keyword args. In particular, I do not want to duplicate the defaults of _preprocess_data.
The docstring was just a copy from _preprocess_data. I've now removed the optional, and default notes.
1358ce9 to
4eb99b4
Compare
dstansby
approved these changes
Jan 8, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Summary
This is just a minor refactoring of the
_preprocess_datadecorator when I looked into #10189.It extracts the docstring manipulation to a dedicated function. The functionality itself is unchanged so far. But it will help for working on #10189 further whatever will be decided there.