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

Add documentation for class Mask #22

Open
spiani opened this issue Oct 15, 2024 · 0 comments
Open

Add documentation for class Mask #22

spiani opened this issue Oct 15, 2024 · 0 comments
Assignees

Comments

@spiani
Copy link
Collaborator

spiani commented Oct 15, 2024

Currently, the Mask class is one of the most critical components of bit.sea. However, its code lacks proper documentation and could benefit from improved readability.

We should add documentation to make this class more accessible for use in other projects, such as MER.

It may also be sensible to have this class inherit from the Mesh class (see #21), as it provides a similar interface and is well-documented and tested.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant