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

Improves docs for tree_at and tree_check. #877

Merged
merged 1 commit into from
Oct 12, 2024
Merged

Improves docs for tree_at and tree_check. #877

merged 1 commit into from
Oct 12, 2024

Conversation

patrick-kidger
Copy link
Owner

Supersedes #874.
Fixes #872.

Copy link

@jeertmans jeertmans left a comment

Choose a reason for hiding this comment

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

I think this is great! I just spot a possible typo.

equinox/_tree.py Outdated
Comment on lines 421 to 422
"""Checks if the PyTree has no self-references, and if all non-leaf nodes unique
Python objects. (For example something like `x = [1]; y = [x, x]` would fail as `x`

Choose a reason for hiding this comment

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

Suggested change
"""Checks if the PyTree has no self-references, and if all non-leaf nodes unique
Python objects. (For example something like `x = [1]; y = [x, x]` would fail as `x`
"""Checks if the PyTree has no self-references, and if all non-leaf nodes are unique
Python objects. (For example something like `x = [1]; y = [x, x]` would fail as `x`

I think you missed a word here, no?

@patrick-kidger patrick-kidger merged commit 40eac53 into main Oct 12, 2024
2 checks passed
@patrick-kidger patrick-kidger deleted the tree-docs branch October 12, 2024 16:51
@patrick-kidger
Copy link
Owner Author

Thanks for the typo catch! Fixed, and merged. :)

@jeertmans
Copy link

Thanks!

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.

tree_at silently skips __check_init__
2 participants