-
-
Notifications
You must be signed in to change notification settings - Fork 469
Fix RPC function docstrings for accuracy and consistency #5080
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
Fix RPC function docstrings for accuracy and consistency #5080
Conversation
…-kk/mathesar into fix-rpc-docstrings
…it_rpc_docstrings.py
|
i fix the issue and all checklist are passed |
mathemancer
left a 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.
Good work overall. Changes requested:
- Resolve the merge conflict noted in a specific comment.
- Remove
DOCSTRING_AUDIT_REPORT.md - Remove
audit_rpc_docstrings.py
Thank you!
mathesar/rpc/records.py
Outdated
| <<<<<<< HEAD | ||
| filter: An array of filter definition objects. | ||
| grouping: An array of group definition objects. | ||
| joined_columns: An array of dict(s) that include an "alias" and "join_path" where, | ||
| "join_path" represents linkages via a simple many-to-many mapping to a column in another table. | ||
| ======= | ||
| filter: A filter definition object. | ||
| grouping: A group definition object. | ||
| >>>>>>> a12d1f06c42905f9b9ca6b44bd2549a3ba34ceaa |
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.
You need to sort out this merge conflict.
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.
i resolved that and i changes the file is correct
mathemancer
left a 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.
Okay, LGTM.
Fix RPC function docstrings for accuracy and consistency
65f1199
Fixes #4013
This pull request audits and fixes various RPC function docstrings across the mathesar/rpc/ directory. It corrects inaccuracies where docstrings did not match the actual function behavior, arguments, or return values, often due to copy-paste errors or outdated information.
Technical details
Revised docstrings in multiple modules including analytics, collaborators, columns, constraints, data_modeling, databases, explorations, forms, records, roles, schemas, servers, tables, and users.
Corrected specific recurring issues such as:
get methods incorrectly having "List information..." summaries.
Copy-paste errors where descriptions referred to different functions (e.g., analytics.disable having the description for analytics.initialize).
Incorrect argument names in Args sections preventing proper introspection.
Added audit_rpc_docstrings.py to programmatically check for docstring consistency issues and generated DOCSTRING_AUDIT_REPORT.md to track the audit results.
Checklist
Update index.md).developbranch of the repositoryvisible errors.
Developer Certificate of Origin
Developer Certificate of Origin