Repository navigation
Fix argument names in docstrings - #9149
Conversation
Signed-off-by: Caitlin Leonard <caitlinsimona@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: Project-MONAI/MONAI/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (5)
Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review. 📝 WalkthroughWalkthroughFive docstrings now use corrected parameter names: Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~4 minutes Merge Risk: ⚪ Minimal · up to 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)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
ericspod
left a comment
There was a problem hiding this comment.
Hi @caitlin-leonard thanks for these fixes, it looks good to go now.
### 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 `Transform`s, not `MapTransform`s) - `AffineBoxToImageCoordinated`, `AffineBoxToWorldCoordinated`: `remove_empty` - `LabelQualityScore`: `spatial_map` (only `VarianceMetric` takes it) Documentation only; no behaviour change. Follow-up to #9149. ### Types of changes <!--- Put an `x` in all the boxes that apply, and remove the not applicable items --> - [x] Non-breaking change (fix or new feature that would not break existing functionality). - [x] In-line docstrings updated. Signed-off-by: Caitlin Leonard <caitlinsimona@gmail.com> Co-authored-by: Eric Kerfoot <17726042+ericspod@users.noreply.github.com>
Description
Fixes docstrings that name an argument the function doesn't have:
PatchDiscriminator:act->activationBundleGen:mlfow_experiment_name->mlflow_experiment_nameDDPMScheduler._get_mean:x0->x_0DiffusionInferer._get_decoder_log_likelihood:input->inputs_matching_no_gt:dt_scores->pred_scoresDocumentation only; no behaviour change. Follow-up to #9148.
Types of changes