Important precursor to API development - #205
Merged
Merged
Conversation
All of these files have had function docstrings improved into Google-style Python docstrings. Why is this important? Because if we're going to have a public API, we'll want to have it documented well. This kind of things lends itself well to being able to automatically generate API docs suitable for hosting on ReadTheDocs.io. No _code_ was changed. Only docstrings. All tests are passing.
Codyjackson0321
approved these changes
Sep 9, 2026
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
2 participants
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.
All of these files have had function docstrings improved into Google-style Python docstrings.
Why is this important? Because if we're going to have a public API, we'll want to have it documented well. This kind of things lends itself well to being able to automatically generate API docs suitable for hosting on ReadTheDocs.io.
No code was changed. Only docstrings. All tests are passing.