RepoURLModifier is more IDE- and user-friendly #760
Merged
Conversation
This file contains 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
In addition to explicitly declaring the kwargs to `__init__` and `__call__`, I took a step back and considered if there was any value to storing `path_append` and `ensure_trailing_slash` as stateful defaults. Based on the current usage and my best judgement, there was no value in that, and in fact having the same signature for both methods only made things more confusing. Hopefully the stateful nature of of this class is more clear, so in addition to being IDE-friendly, it's much easier for humans to grok. https://pulp.plan.io/issues/1442 fixes pulp#1442
| :ivar conf: URL modifier persistent configuration, populated from optional keyword | ||
| arguments (see :py:meth:`RepoURLModifier.__call__` for allowed options). | ||
| :type conf: dict | ||
| Initialize the URL modifier with defaults, populated from optional keyword arguments |
There was a problem hiding this comment.
s/, populated from optional keyword arguments// ?
There was a problem hiding this comment.
I struggled a bit with wording. "from an optional keyword argument", "with a default query auth token", just end the line at "with defaults", etc. I think this is still my preferred wording.
seandst
added a commit
that referenced
this pull request
Jan 30, 2016
RepoURLModifier is more IDE- and user-friendly
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.
In addition to explicitly declaring the kwargs to
__init__and__call__, I took a step back and considered if there was any valueto storing
path_appendandensure_trailing_slashas stateful defaults.Based on the current usage and my best judgement, there was no value in
that, and in fact having the same signature for both methods only made
things more confusing. Hopefully the stateful nature of of this class is
more clear, so in addition to being IDE-friendly, it's much easier for
humans to grok.
https://pulp.plan.io/issues/1442
fixes #1442