Skip to content

Fix argument names in docstrings - #9149

Merged
ericspod merged 1 commit into
Project-MONAI:devfrom
caitlin-leonard:fix-docstring-arg-names
Oct 2, 2026
Merged

ericspod merged 1 commit into
Project-MONAI:devfrom
caitlin-leonard:fix-docstring-arg-names

Conversation

@caitlin-leonard

@caitlin-leonard caitlin-leonard commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Description

Fixes docstrings that name an argument the function doesn't have:

  • PatchDiscriminator: act -> activation
  • BundleGen: mlfow_experiment_name -> mlflow_experiment_name
  • DDPMScheduler._get_mean: x0 -> x_0
  • DiffusionInferer._get_decoder_log_likelihood: input -> inputs
  • _matching_no_gt: dt_scores -> pred_scores

Documentation only; no behaviour change. Follow-up to #9148.

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • In-line docstrings updated.

Signed-off-by: Caitlin Leonard <caitlinsimona@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: Project-MONAI/MONAI/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: f51fc007-ddaa-45ba-91af-b3264d9346f7

📥 Commits

Reviewing files that changed from the base of the PR and between 02a8ef3 and 8394e3e.

📒 Files selected for processing (5)
  • monai/apps/auto3dseg/bundle_gen.py
  • monai/apps/detection/metrics/matching.py
  • monai/inferers/inferer.py
  • monai/networks/nets/patchgan_discriminator.py
  • monai/networks/schedulers/ddpm.py

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

Five docstrings now use corrected parameter names: mlflow_experiment_name, pred_scores, inputs, activation, and x_0. The changes do not alter executable behavior or public declarations.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Merge Risk: ⚪ Minimal · up to 8394e

This PR corrects five parameter names in docstrings without changing behavior; the supplied evidence reports that each corrected name matches its parameter. No merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 5 files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the main change: correcting argument names in docstrings.
Description check ✅ Passed The description explains all five documentation changes, states that behavior is unchanged, and includes the relevant checklist selections. The issue-reference line from the template is not included, …
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

@ericspod ericspod left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @caitlin-leonard thanks for these fixes, it looks good to go now.

@ericspod
ericspod enabled auto-merge (squash) October 2, 2026 19:24
@ericspod
ericspod merged commit b087a1b into Project-MONAI:dev Oct 2, 2026
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants