Skip to content

Remove docs for parameters that don't exist - #9169

Open
caitlin-leonard wants to merge 1 commit into
Project-MONAI:devfrom
caitlin-leonard:fix-stale-param-docs
Open

caitlin-leonard wants to merge 1 commit into
Project-MONAI:devfrom
caitlin-leonard:fix-stale-param-docs

Conversation

@caitlin-leonard

Copy link
Copy Markdown
Contributor

Description

Removes docstring entries for parameters that these classes don't accept.
Passing them, as the docs suggest, raises a TypeError:

  • GenerateInstanceBorderd, GenerateWatershedMarkersd: allow_missing_keys
    (these are plain Transforms, not MapTransforms)
  • AffineBoxToImageCoordinated, AffineBoxToWorldCoordinated: remove_empty
  • LabelQualityScore: spatial_map (only VarianceMetric takes it)

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

Types of changes

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

Assisted-by: Claude <noreply@anthropic.com>
Signed-off-by: Caitlin Leonard <caitlinsimona@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 13, 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: c68ba477-3411-40e6-b83e-53a9c9ef9fe5
📥 Commits

Reviewing files that changed from the base of the PR and between 03e208f and 93a6ccc.

📒 Files selected for processing (3)
  • monai/apps/detection/transforms/dictionary.py
  • monai/apps/pathology/transforms/post/dictionary.py
  • monai/metrics/active_learning_metrics.py
💤 Files with no reviewable changes (3)
  • monai/metrics/active_learning_metrics.py
  • monai/apps/detection/transforms/dictionary.py
  • monai/apps/pathology/transforms/post/dictionary.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

Removed documentation for unsupported parameters from two detection transforms, two pathology transforms, and LabelQualityScore. Constructors, public signatures, and implementation behavior remain unchanged.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to 93a6c

This is a documentation-only correction with no runtime behavior change, so it is safe to merge.

Pre-merge checks · Passed 5
Passed Passed checks (5 passed)
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: removing documentation for unsupported parameters.
Description check Passed The description explains the affected classes, unsupported parameters, TypeError impact, and documentation-only scope. It includes the change type and docstring update checkbox. The issue reference an…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ 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.

This branch has not been deployed

No deployments
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.

1 participant