Skip to content

Conversation

onel
Copy link

@onel onel commented Oct 10, 2025

First batch of files with adding reference documentation to some files.
This is a test run to see if the style + content is helpful.

It follows the google docstring style but if the methods have types added it does not also add the Args: Returns: because that would be duplicate information. And also at risk of becoming out of sync.

Feedback more than welcomed.

#8930

Copy link
Collaborator

@chenmoneygithub chenmoneygithub left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

Let's make sure every PR handles relevant files, for this specific one we can keep simba_utils.py only.

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.

2 participants