docs: missing API documentation and docstrings#382
Open
zendy199x wants to merge 1 commit intoopenworm:experimentalfrom
Open
docs: missing API documentation and docstrings#382zendy199x wants to merge 1 commit intoopenworm:experimentalfrom
zendy199x wants to merge 1 commit intoopenworm:experimentalfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves developer usability of master_openworm.py by adding API documentation, focusing on clarifying how execute_with_realtime_output is intended to be used.
Changes:
- Added a docstring to
execute_with_realtime_outputdescribing parameters, return values, and error behavior.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
zendy199x
force-pushed
the
docs/missing-api-documentation-and-docstrings
branch
from
804ce0f to
565c325
Compare
Signed-off-by: Zendy <50132805+zendy199x@users.noreply.github.com>
zendy199x
force-pushed
the
docs/missing-api-documentation-and-docstrings
branch
from
565c325 to
c12f362
Compare
mitre88
pushed a commit
to mitre88/OpenWorm
that referenced
this pull request
Apr 18, 2026
Adds comprehensive docstring to execute_with_realtime_output documenting parameters, return values, and exceptions. Addresses openworm#382.
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
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
The master_openworm.py script contains no docstrings for functions or classes, and lacks API documentation. The execute_with_realtime_output function is particularly important but has no documentation explaining its parameters, return values, or expected behavior. This makes it difficult for developers to understand and use the code properly.
Changes
master_openworm.pyAdd comprehensive docstrings to all functions including parameter descriptions, return values, and exceptions. For execute_with_realtime_output, document the command, directory, env, and exit_on_failure parameters, and explain what the function returns and when it might raise exceptions.