Skip to content

Docstrings and exceptions #25

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Aug 12, 2025
Merged

Docstrings and exceptions #25

merged 1 commit into from
Aug 12, 2025

Conversation

peteski22
Copy link
Contributor

  • Add exception hierarchy
  • Add detailed docstrings (and improve type hinting on function signatures)
  • Make as much private as possible

@peteski22
Docstrings and exceptions
40cb116 
* Add exception hierarchy
* Add detailed docstrings (and improve type hinting on function signatures)
* Make as much private as possible
@peteski22 peteski22 added the documentation Improvements or additions to documentation label Aug 11, 2025
Copilot
Copilot AI reviewed Aug 11, 2025
View reviewed changes
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@peteski22 peteski22 requested a review from Copilot August 12, 2025 07:05
Copilot
Copilot AI reviewed Aug 12, 2025
View reviewed changes
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

aittalam
aittalam approved these changes Aug 12, 2025
View reviewed changes
Copy link
Member

@aittalam aittalam left a comment

Choose a reason for hiding this comment

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

Thanks @peteski22 ! I just added a nit question re: linting but apart from that this LGTM - many thanks for making the code more self-explanatory 🙏

@peteski22 peteski22 merged commit bc611e1 into main Aug 12, 2025
7 checks passed
@peteski22 peteski22 deleted the peteski22/docstrings branch August 12, 2025 11:22
@peteski22 peteski22 mentioned this pull request Aug 12, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@aittalam aittalam aittalam approved these changes

@dpoulopoulos dpoulopoulos Awaiting requested review from dpoulopoulos

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@peteski22 @aittalam