Summary
Document the filename parameter of dump_models_group in src/utils/models_dumper.py.
Required changes
Update the dump_models_group(model_group: str, filename: Optional[str] = None) docstring to describe:
filename as an optional output filename.
- The default behavior: when omitted, the schema is written to
<model_group>.json.
Use the repository's established Parameters: docstring format.
Rationale
The function is public and accepts filename, but its current docstring does not document that parameter or the default output-filename behavior.
Affected area
src/utils/models_dumper.py
dump_models_group
Acceptance criteria
- The docstring documents both
model_group and filename.
- The
filename documentation states that it is optional and defaults to <model_group>.json when omitted.
- The documentation follows the repository's
Parameters: format.
Backlinks
Requested by: @tisnik
Summary
Document the
filenameparameter ofdump_models_groupinsrc/utils/models_dumper.py.Required changes
Update the
dump_models_group(model_group: str, filename: Optional[str] = None)docstring to describe:filenameas an optional output filename.<model_group>.json.Use the repository's established
Parameters:docstring format.Rationale
The function is public and accepts
filename, but its current docstring does not document that parameter or the default output-filename behavior.Affected area
src/utils/models_dumper.pydump_models_groupAcceptance criteria
model_groupandfilename.filenamedocumentation states that it is optional and defaults to<model_group>.jsonwhen omitted.Parameters:format.Backlinks
Requested by: @tisnik