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

jax.numpy: better docstring for append function #21615

Merged
merged 1 commit into from
Jun 7, 2024

Conversation

selamw1
Copy link
Contributor

@selamw1 selamw1 commented Jun 4, 2024

New docstring and JAX-specific code examples are addd for jax.numpy.append.
Part of 21461.

jax/_src/numpy/lax_numpy.py Outdated Show resolved Hide resolved
jax/_src/numpy/lax_numpy.py Outdated Show resolved Hide resolved
jax/_src/numpy/lax_numpy.py Outdated Show resolved Hide resolved
@jakevdp jakevdp self-assigned this Jun 4, 2024
Copy link
Collaborator

@jakevdp jakevdp left a comment

Choose a reason for hiding this comment

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

It looks like you may have rebased against an older version of the main branch, which caused commits from the newer version of the main branch to be considered part of your PR. The best fix would be to rebase again against the most recent main branch.

jax/_src/test_util.py Outdated Show resolved Hide resolved
jax/_src/numpy/lax_numpy.py Outdated Show resolved Hide resolved
@selamw1
Copy link
Contributor Author

selamw1 commented Jun 4, 2024

Thanks @jakevdp
break lines are added and commits rebased.

jax/_src/numpy/lax_numpy.py Outdated Show resolved Hide resolved
jax/_src/numpy/lax_numpy.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@jakevdp jakevdp left a comment

Choose a reason for hiding this comment

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

Looks great! Last thing we need is to squash all the changes into a single commit, and then we can merge (see https://jax.readthedocs.io/en/latest/contributing.html#single-change-commits-and-pull-requests) Thanks!

append_docstring_modified

append_doc_line_break

append_doc_linting_fixed
@selamw1
Copy link
Contributor Author

selamw1 commented Jun 7, 2024

@jakevdp all commits squashed into one.

Copy link
Collaborator

@jakevdp jakevdp left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@google-ml-butler google-ml-butler bot added kokoro:force-run pull ready Ready for copybara import and testing labels Jun 7, 2024
@copybara-service copybara-service bot merged commit 25cc84b into jax-ml:main Jun 7, 2024
13 of 14 checks passed
@selamw1 selamw1 deleted the append_doc branch June 10, 2024 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pull ready Ready for copybara import and testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants