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

Fix formatting in docs for transposing pytrees #25686

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Mikcl
Copy link

@Mikcl Mikcl commented Dec 26, 2024

{func} is currently present in the rendered docs. There should be no space between {func} and following word.

How it is currently rendered:

https://jax.readthedocs.io/en/latest/working-with-pytrees.html#transposing-pytrees-with-jax-tree-map-and-jax-tree-transpose

To transpose a pytree (turn a list of trees into a tree of lists), JAX has two functions: {func} jax.tree.map (more basic) and jax.tree.transpose (more flexible, complex and verbose).

Copy link

google-cla bot commented Dec 26, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@Mikcl Mikcl force-pushed the docs/working-with-pytrees-formatting branch from f70dc2d to 008c25a Compare December 26, 2024 01:18
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.

1 participant