[Bug] [Python] fix python docs example quoting #2669
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
wing328
changed the title
This was referenced Oct 1, 2023
This was referenced Nov 28, 2023
This was referenced Apr 10, 2024
This was referenced May 13, 2024
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.
PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh,./bin/openapi3/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\.master,. Default:3.4.x,4.0.xmaster.@taxpon @frol @mbohlool @cbornet @kenjones-cisco @tomplus @Jyhess
Description of the PR
See #2092 for bug details.
This solution overrides the 2-param
setParameterExampleValue()method to make sure that the 1-paramsetParameterExampleValue()gets called every time, which will hopefully guarantee that examples for strings will be wrapped in quotes properly in the generated docs.I also changed instances of
"NULL"to"None"so that even when no example value is generated, the resulting code will at least be valid python code. Let me know if there's another way you would prefer to handle that.