Skip to content

add docstrings to functions that lack them#347

Merged
adhil0 merged 5 commits intomainfrom
more-docstrings
Nov 19, 2025
Merged

add docstrings to functions that lack them#347
adhil0 merged 5 commits intomainfrom
more-docstrings

Conversation

@dcritch
Copy link
Contributor

@dcritch dcritch commented Nov 17, 2025

Went through the code base to add Google-style docstrings to any function that didn't have it yet.

Fixes #269

Assisted-by: Cursor

@dcritch dcritch requested a review from adhil0 November 17, 2025 23:25
@dcritch
Copy link
Contributor Author

dcritch commented Nov 18, 2025

@adhil0 had to fix the github workflow, but all seems good now. can you take a look?

Copy link
Collaborator

@adhil0 adhil0 left a comment

Choose a reason for hiding this comment

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

Made some minor suggestions, feel free to reject them if they don't fit. Either way, thanks for doing this, will make our code much easier to work with

dcritch and others added 2 commits November 19, 2025 13:22
docstrings shouldn't be longer than the function itself

Co-authored-by: Adhitya Logan <[email protected]>
Copy link
Collaborator

@adhil0 adhil0 left a comment

Choose a reason for hiding this comment

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

Perfect, thanks! Will make life a lot easier

@adhil0 adhil0 merged commit 76876a4 into main Nov 19, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docstrings to functions

2 participants