-
-
Notifications
You must be signed in to change notification settings - Fork 395
fix: remove duplicate docstring from release mixin property #2966
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings. WalkthroughRemoved a redundant docstring line from the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
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 |
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR fixes a documentation issue by removing an incorrect duplicate docstring from the idx_author property in the release model mixin.
- Removed the second, incorrect docstring ("Get top contributors.") from the
idx_authorproperty - Retained the correct docstring ("Return author for indexing.") which accurately describes the property's purpose
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey, please update the docstrings to include other property information as stated in the issue:
Mixin classes have property methods lacking docstrings. Add docstrings explaining what each property returns and its purpose.
Sure will update and let u know! |
I have updated this PR in the PR #2998 Mentioned here., kindly check @rudransh-shrivastava and let me know the changes or the update needed ..,please!!!! |
|
@dharshan-kumarj Hey, sorry for the late response. I saw the other PR (#2998). While the changes look good to me, I think it would be better if you update this one instead. |
Understood. I’ve already applied the required changes in the new PR (#2998). |
|
@dharshan-kumarj It's better for historical context and documentation purposes. A new PR works for now, I'll take a look at #2998. |
Okiee finee, Then let me know about the merge or any updates if required in the new PR |



Description
This PR fixes a duplicate docstring issue in the release mixin file.
Changes
Related Issue
Closes #2648