refactor(idutils): rename GenerateExternalIDForDocument to GenerateExternalID #1713
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
|
| @@ -51,8 +52,8 @@ func GenerateExternalIDForSettingsObject(c coordinate.Coordinate) (string, error | |||
|
|
|||
| type ExternalIDGenerator func(coordinate.Coordinate) (string, error) | |||
|
|
|||
| // GenerateExternalIDForDocument generates an external ID for a document configuration. It is under 50 characters long and uses at most only "a-z", "A-Z", "0-9" and "-". | |||
| func GenerateExternalIDForDocument(c coordinate.Coordinate) (string, error) { | |||
| // GenerateExternalID generates an external ID for a document configuration. It is under 50 characters long and uses at most only "a-z", "A-Z", "0-9" and "-". | |||
There was a problem hiding this comment.
Suggested change
| // GenerateExternalID generates an external ID for a document configuration. It is under 50 characters long and uses at most only "a-z", "A-Z", "0-9" and "-". | |
| // GenerateExternalID generates an external ID for a configuration. It is under 50 characters long and uses at most only "a-z", "A-Z", "0-9" and "-". |
| @@ -51,8 +52,8 @@ func GenerateExternalIDForSettingsObject(c coordinate.Coordinate) (string, error | |||
|
|
|||
| type ExternalIDGenerator func(coordinate.Coordinate) (string, error) | |||
|
|
|||
| // GenerateExternalIDForDocument generates an external ID for a document configuration. It is under 50 characters long and uses at most only "a-z", "A-Z", "0-9" and "-". | |||
| func GenerateExternalIDForDocument(c coordinate.Coordinate) (string, error) { | |||
| // GenerateExternalID generates an external ID for a document configuration. It is under 50 characters long and uses at most only "a-z", "A-Z", "0-9" and "-". | |||
There was a problem hiding this comment.
Just an idea: As the function takes the coordinate, could it absorb the function above for settings and then provide the correct externalID after examining the config type?
There was a problem hiding this comment.
I like the idea, lets align at the daily :)
There was a problem hiding this comment.
Kind of like that as well, though we do increase cohesion 🤔
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.
What this PR does / Why we need it:
As the
GenerateExternalIDForDocumentis being used also in other API than Documents, it was renamed toGenerateExternalIDSpecial notes for your reviewer:
Does this PR introduce a user-facing change?