[python] Update docs/ Markdown files for Classes to fix _form_ typo and correct casing for class name when calling from_dict() #18359
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.
All changes contained in 5385bcb
This only affects
docs/
markdown files, so this is not a breaking change.In the Python generated docs (for all three generators
python
,python-fastapi
, andpython-pydantic-v1
), below is an example of what gets formed for the example snippet:Hovering over
dog_model
in the last row shows the error"dog_model" is not defined
. The snippet works as expected ifdog_model
is insteadDogModel
, so that from_dict() is called against an emptyobject
.This also additionally changes
dog_model_form_dict
todog_model_from_dict
to match the methodfrom_dict()
.PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*
.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master
(upcoming 7.1.0 minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)Python Technical Committee
@cbornet (2017/09) @tomplus (2018/10) @krjakbrjak (2023/02) @fa0311 (2023/10) @multani (2023/10)