Change constructor arg "name" to "identity" #135
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
The use of "name" as the argument caused confusion. The argument does not populate the "name" field of an object. Rather, it is used to populate the identity and/or display_id. Switch to calling it identity, which is the first use in the heuristic. If the value is not a valid identity it is assumed to be a display_id and concatenated with a default namespace if one exists.
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.
The use of "name" as the argument caused confusion. The argument does not populate the "name" field of an object. Rather, it is used to populate the identity and/or display_id. Switch to calling it identity, which is the first use in the heuristic. If the value is not a valid identity it is assumed to be a display_id and concatenated with a default namespace if one exists.
@bbartley @tramyn this pull request contains a change that is not backward compatible. It is very likely that some of your code will have to change. You will need to change any registered builders (via
Document.register_builder) to rename thenameargument toidentity.Additionally if you have code that invokes a constructor using a
namekeyword argument, that invocation must be updated by renamingnametoidentity.CC: @jakebeal
Closes #130