-
Notifications
You must be signed in to change notification settings - Fork 241
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
Lack of Basic Docstrings in Mercury WIdget #380
Comments
Good point @ranggakd. Ive assigned issue for you. In case any questions, Im happy to help. |
Hello @pplonski, thank you for the opportunity to contribute to enhancing the Mercury widget docstrings. I'm eager to get started and want to ensure we're on the same page as it's my first time contributing to a large open-source project.
|
Hi @ranggakd,
Thank you! |
#380 PR of Enhancing Docstrings & Highlighting Potential Issues
Description
I've noticed that the Mercury widget lacks basic docstrings. This makes it difficult to understand what each function does and how to use them properly on the go without going back and forward to the documentation page.
Suggested Enhancement
Adding docstrings to the functions in the Mercury widget would greatly improve its usability and maintainability. These docstrings should include:
Comparison with
pandas
Here's the comparison of docstring between
mr.Select
andpd.DataFrame
:mr.Select()
and the source codepd.DataFrame()
and the source codeSuggestion
I'm interested in contributing to this enhancement. I believe that adding these docstrings would greatly improve the usability and maintainability of the Mercury overall. I'm ready to start working on this as soon as I get your approval. Looking forward to contributing to this project!
The text was updated successfully, but these errors were encountered: