CFE-3809: Updated files transformer docs and example #2580
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
This change switches to a core/example and removes misleading information indicating that the transformer is intended to create the promised file. This is not and never has been (to my knowledge) the behavior of the transformer attribute. In order to trigger the promised file MUST exist. The example illustrating how to invert the logic is misleading and would not trigger until aliases were updated again, also it would not properly re-generate the aliases db if the db were removed. I have seen this several times where there is confusion and users think that transformer is intended to create the promised file, to avoid that going forward I have refactored the docs for this attribute to omit that suggestion and better highlight the behavior. Ticket: CFE-3809 Changelog: None
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.
This change switches to a core/example and removes misleading information
indicating that the transformer is intended to create the promised file.
This is not and never has been (to my knowledge) the behavior of the transformer
attribute.
In order to trigger the promised file MUST exist. The example illustrating how
to invert the logic is misleading and would not trigger until aliases were
updated again, also it would not properly re-generate the aliases db if the db
were removed.
I have seen this several times where there is confusion and users think that
transformer is intended to create the promised file, to avoid that going forward
I have refactored the docs for this attribute to omit that suggestion and better
highlight the behavior.
Ticket: CFE-3809
Changelog: None