Repository navigation
docs: add module docstrings and return type annotations - #18
Merged
Merged
Conversation
Improve code navigability by adding module-level docstrings to all core classes and utility modules, and completing missing return type annotations on ~25 public methods. Also removes dead commented-out code in StimBank and adds an explanatory comment for the closure introspection pattern.
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.
Improve code navigability by adding module-level docstrings to all core classes and utility modules, and completing missing return type annotations on ~25 public methods. Also removes dead commented-out code in StimBank and adds an explanatory comment for the closure introspection pattern.
One of the perks of psyflow is its agent-friendly design, this kind of change make it effectively easier to navigate the codebase.