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.

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

Wrap functionality in Python with nicer typing and docs #767

Merged
merged 34 commits into from
Jan 9, 2024
Merged

Wrap functionality in Python with nicer typing and docs #767

merged 34 commits into from
Jan 9, 2024

Conversation

mscroggs
Copy link
Member

@mscroggs mscroggs commented Jan 8, 2024 •
edited
Loading

  • Added python classes and functions that call functions in wrapper, rather than calling wrapper directly
  • Added documentation and typing
  • Removed *_to_string functions for enums, as .name can be used instead
  • Removed semi-automated copying of docstrings from c++ to Python 🥳

@mscroggs mscroggs marked this pull request as draft January 8, 2024 14:09
@mscroggs mscroggs requested a review from garth-wells January 8, 2024 14:44
@mscroggs mscroggs marked this pull request as ready for review January 8, 2024 14:45
garth-wells
garth-wells approved these changes Jan 9, 2024
View reviewed changes
Copy link
Member

@garth-wells garth-wells left a comment

Choose a reason for hiding this comment

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

Nice!

@mscroggs mscroggs added this pull request to the merge queue Jan 9, 2024
Merged via the queue into main with commit b935d2d Jan 9, 2024
@mscroggs mscroggs deleted the mscroggs/python-docs branch January 9, 2024 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@garth-wells garth-wells garth-wells approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mscroggs @garth-wells