Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: convert docstrings to Google style format #99

Merged
merged 3 commits into from
Jan 9, 2025
Merged

Conversation

coreyjs
Copy link
Owner

@coreyjs coreyjs commented Jan 9, 2025

  • Add parameter types and improve descriptions
  • Standardize Returns sections
  • Add Examples where relevant for API endpoints
  • Maintain existing function implementations

resolves #97 #85

- Add parameter types and improve descriptions
- Standardize Returns sections
- Add Examples where relevant for API endpoints
- Maintain existing function implementations
@coreyjs coreyjs self-assigned this Jan 9, 2025
- Add parameter types and improve descriptions
- Standardize Returns sections
- Add Examples where relevant for API endpoints
- Maintain existing function implementations
@coreyjs coreyjs marked this pull request as ready for review January 9, 2025 23:44
@coreyjs coreyjs merged commit 9e55b10 into main Jan 9, 2025
1 check passed
@coreyjs coreyjs deleted the 97-docstring branch January 9, 2025 23:49
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.

Update docstring style
1 participant