Skip to content

Fix CLI option docstrings and add missing tests#2836

Merged
koxudaxi merged 2 commits intomainfrom
fix-cli-doc-descriptions
Dec 28, 2025
Merged

Fix CLI option docstrings and add missing tests#2836
koxudaxi merged 2 commits intomainfrom
fix-cli-doc-descriptions

Conversation

@koxudaxi
Copy link
Copy Markdown
Owner

@koxudaxi koxudaxi commented Dec 28, 2025

No description provided.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Dec 28, 2025 •
edited
Loading

Warning

Rate limit exceeded

@koxudaxi has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 20 minutes and 11 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e4394af and 35de949.

📒 Files selected for processing (15)
  • docs/cli-reference/field-customization.md
  • docs/cli-reference/index.md
  • docs/cli-reference/model-customization.md
  • docs/cli-reference/quick-reference.md
  • docs/cli-reference/template-customization.md
  • docs/cli-reference/typing-customization.md
  • scripts/build_cli_docs.py
  • src/datamodel_code_generator/cli_options.py
  • src/datamodel_code_generator/prompt_data.py
  • tests/cli_doc/test_cli_options_sync.py
  • tests/data/expected/main/jsonschema/root_model_with_additional_properties_no_use_standard_collections.py
  • tests/data/expected/main/jsonschema/root_model_with_additional_properties_no_use_union_operator.py
  • tests/main/graphql/test_annotated.py
  • tests/main/graphql/test_main_graphql.py
  • tests/main/jsonschema/test_main_jsonschema.py
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-cli-doc-descriptions

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 28, 2025

📚 Docs Preview: https://pr-2836.datamodel-code-generator.pages.dev

@codecov
Copy link
Copy Markdown

codecov Bot commented Dec 28, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.51%. Comparing base (0f06a7d) to head (35de949).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2836      +/-   ##
==========================================
- Coverage   99.52%   99.51%   -0.02%     
==========================================
  Files          90       90              
  Lines       13999    14100     +101     
  Branches     1668     1674       +6     
==========================================
+ Hits        13932    14031      +99     
- Misses         36       37       +1     
- Partials       31       32       +1
Flag Coverage Δ
unittests 99.51% <100.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Dec 28, 2025

CodSpeed Performance Report

Merging #2836 will not alter performance

Comparing fix-cli-doc-descriptions (35de949) with main (e4394af)

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

Summary

✅ 11 untouched
⏩ 98 skipped1

Footnotes

  1. 98 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

@koxudaxi koxudaxi merged commit fca31fe into main Dec 28, 2025
37 of 38 checks passed
@koxudaxi koxudaxi deleted the fix-cli-doc-descriptions branch December 28, 2025 14:45
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 28, 2025

Breaking Change Analysis

Result: No breaking changes detected

Reasoning: This PR contains only documentation improvements and additional test coverage. The changes include: (1) fixing CLI option docstrings from test-specific language to proper user-facing descriptions, (2) adding missing CLI_OPTION_META entries for --use-union-operator and --use-standard-collections (options that already existed in argparse), (3) adding new test cases for --no-use-standard-collections and --no-use-union-operator, (4) updating auto-generated CLI reference documentation, and (5) adding a helper function get_all_argparse_options(). There are no changes to actual CLI behavior, code generation output, default values, error handling, or Python version requirements. All CLI options continue to work exactly as before.

This analysis was performed by Claude Code Action

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 1, 2026

🎉 Released in 0.51.0

This PR is now available in the latest release. See the release notes for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

breaking-change-analyzed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@koxudaxi