Skip to content

Conversation

@karthikeyan24-kk
Copy link
Contributor

@karthikeyan24-kk karthikeyan24-kk commented Dec 7, 2025

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

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@seancolsen seancolsen added the pr-status: review A PR awaiting review label Dec 8, 2025
@karthikeyan24-kk
Copy link
Contributor Author

i fix the issue and all checklist are passed

Copy link
Contributor

@mathemancer mathemancer left a 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!

Comment on lines 308 to 316
<<<<<<< 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
Copy link
Contributor

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.

Copy link
Contributor Author

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

Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, LGTM.

@mathemancer mathemancer added this pull request to the merge queue Dec 11, 2025
github-merge-queue bot pushed a commit that referenced this pull request Dec 11, 2025
Fix RPC function docstrings for accuracy and consistency
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 11, 2025
@mathemancer mathemancer added this pull request to the merge queue Dec 11, 2025
Merged via the queue into mathesar-foundation:develop with commit 65f1199 Dec 11, 2025
143 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr-status: review A PR awaiting review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Double-check RPC function docstrings before beta release

3 participants