Skip to content

Fix mistakes and add missing details in the API reference docstrings and v5 migration - #1010

Merged
mauvilsa merged 2 commits into
mainfrom
api-docstrings-review
Oct 12, 2026
Merged

mauvilsa merged 2 commits into
mainfrom
api-docstrings-review

Conversation

@mauvilsa

Copy link
Copy Markdown
Owner

Before submitting

  • Did you read the contributing guideline?
  • If you used a coding agent, did you fully understand and validate all generated code and ensure it follows the contributing guidelines?
  • Did you update the documentation? (readme and public docstrings)
  • [n/a] Did you write unit tests such that there is 100% coverage on related code? (required for bug fixes and new features)
  • Did you verify that new and existing tests pass locally?
  • [n/a] If this is a bug fix, did you verify that the tests fail without the code fix?
  • Did you make sure that all changes preserve backward compatibility?
  • [n/a] Did you update the CHANGELOG including a pull request link? (not for typos, docs, test updates, or minor internal changes/refactors)

@mauvilsa mauvilsa added the documentation Improvements to the documentation label Oct 12, 2026
@greptile-apps

greptile-apps Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 4/5

[Low impact] Fixes docstring wording and adds missing documentation details.

The PR appears safe to merge, with one non-blocking correction to the sub_configs description.

Findings

  1. P2 File loading support is overstated ▶

Summary

Updates the API reference and v5 migration guide.

  • Parser API docs explain config and command-line options.
  • Value helper docs explain paths, namespaces, and typed arguments.
  • The v5 guide gives clearer names and replacement examples.

Reviews (1) · Last reviewed commit: "Fix mistakes and add missing details in ..." · Reviewed by Greptile

Comment thread jsonargparse/_signatures.py Outdated
@mauvilsa
mauvilsa deployed to sonarcloud October 12, 2026 05:57 — with GitHub Actions Active
@codecov

codecov Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (7557e75) to head (98d1b1e).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1010   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           27        27           
  Lines         9814      9814           
=========================================
  Hits          9814      9814           

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

@sonarqubecloud

Copy link
Copy Markdown

@mauvilsa
mauvilsa merged commit 97001d0 into main Oct 12, 2026
32 checks passed
@mauvilsa
mauvilsa deleted the api-docstrings-review branch October 12, 2026 06:13

This branch was successfully deployed

1 active deployment
sonarcloud — 98d1b1ef Deployed Oct 12, 2026 by mauvilsa via sonarcloud #965
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant