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

[Feature Request] Document masks in tensor specs #2280

Closed
vmoens opened this issue Jul 9, 2024 · 1 comment · Fixed by #2289
Closed

[Feature Request] Document masks in tensor specs #2280

vmoens opened this issue Jul 9, 2024 · 1 comment · Fixed by #2289
Assignees
Labels
enhancement New feature or request

Comments

@vmoens
Copy link
Contributor

vmoens commented Jul 9, 2024

Various classes in the specs have the "mask" entry undocumented:

The docstrings should explain that this mask can be set to hide part of the discrete specs to hide part of the domain.
The docstrings should also explain how the mask can be updated (using spec.update_mask).
An example should be provided with the mask. See the tests to understand how the mask is used:

class TestSpecMasking:

@kurtamohler is it something you could help with?

@vmoens vmoens added the enhancement New feature or request label Jul 9, 2024
@vmoens vmoens self-assigned this Jul 9, 2024
@kurtamohler
Copy link
Collaborator

@kurtamohler is it something you could help with?

Sure thing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants