docs: remove stale parameters from docstrings#10072
Open
eeshsaxena wants to merge 1 commit into
Open
Conversation
- _mcp/server/main.py: setup_mcp_server documented `server_name` and `stateless_http` args (not parameters) and a stale Returns section (the function returns None) - _session/notebook/serializer.py: NotebookSerializer.serialize documented stale `path` and `previous_path` args - _sql/utils.py: convert_to_output documented a stale `result` arg
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
All contributors have signed the CLA ✍️ ✅ |
Author
|
I have read the CLA Document and I hereby sign the CLA |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Summary
Removes stale documented parameters that no longer exist in the function signatures:
marimo/_mcp/server/main.pysetup_mcp_serverserver_name,stateless_httpargs + a Returns section (function returnsNone)marimo/_session/notebook/serializer.pyNotebookSerializer.serializepath,previous_pathmarimo/_sql/utils.pyconvert_to_outputresultDoc-only change; no behavior modified.
🔍 Description of Changes
Each docstring listed parameters left over from earlier signatures; the entries were removed so the docs match the actual arguments.
📋 Checklist