AVRO-4178: [C#] add documentation on --namespace flag of C# AvroGen #3517
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 is the purpose of the change
Add documentation of a not expected behaviour of --namespace flag of C# AvroGen
Wenn tring to fix AVRO-4187, I identified an issue that all the avro tooling stops working when the --namespace flag really does what you would expect from it.
I think the flag should be removed entirely in a later version.
AvroGen should not have a --namespace flag as the other Avro tooling does not support namespace mappings - so we are depending on a bug in the code generation to be able to deserialize the types again (affecting the contract).
in this PR, I only document this specific behaviour
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Documentation