Skip to content

Conversation

@yemeen
Copy link
Member

@yemeen yemeen commented Nov 24, 2025

Pull Request

Summary

make readme reflect 1.0 changes

Description

rewrote to mention classes directly and change 2d/3d to any dimension. added quick start section.

Motivation and Context

for joss

How has this been tested?

n/a

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [ x ] Documentation update
  • Code refactoring
  • Performance improvement
  • Test improvement

Checklist

  • [ x ] My code follows the code style of this project. (make clean)
  • I have incremented the version number in the pyproject.toml file (if applicable).
  • I have added tests to cover my changes (if applicable).
  • All new and existing tests passed. (make tests)
  • [ x ] I have updated the documentation (if applicable).
  • My changes generate no new warnings.
  • I have added any necessary new dependencies to pyproject.toml.

Additional Notes

Screenshots (if applicable)

@yemeen yemeen requested a review from lizliz as a code owner November 24, 2025 15:58
@lizliz lizliz merged commit bdb4661 into main Nov 24, 2025
2 checks passed
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.

3 participants