jax icon indicating copy to clipboard operation
jax copied to clipboard

DOC: Improved docs for polynomial arithmetic functions of jax.numpy

Open rajasekharporeddy opened this issue 1 year ago • 3 comments

This PR includes better docs and example code snippets for jnp.polyadd, jnp.polysub, jnp.polymul and jnp.polydiv functions.

Part of #21461

rajasekharporeddy avatar Jun 19 '24 15:06 rajasekharporeddy

Hi @jakevdp, Please suggest if I need to make any other changes.

rajasekharporeddy avatar Jun 25 '24 04:06 rajasekharporeddy

Please remove the unused import & fix conflicts!

Also, please comment when you've done this because I don't get notifications if you just push the change (that's why I'm so late coming back to this)

jakevdp avatar Jun 28 '24 17:06 jakevdp

Thanks! Removed the unused import and resolved the conflicts. Also, squashed into single commit.

rajasekharporeddy avatar Jul 01 '24 05:07 rajasekharporeddy

Hi @jakevdp, Could you please have a look at this PR.

rajasekharporeddy avatar Jul 02 '24 12:07 rajasekharporeddy

@rajasekharporeddy — Jake is offline for the next little bit and I'm looking after these docstring update PRs. I'm sorry for missing this yesterday, and please feel free to ping me if I'm missing anything else!

This all looks good - thanks!

dfm avatar Jul 02 '24 13:07 dfm

Thanks @dfm! Fixed the traceback in examples and squashed into single commit.

rajasekharporeddy avatar Jul 02 '24 14:07 rajasekharporeddy

@rajasekharporeddy — I believe the that traceback lines still need to be updated. They should start with:

Traceback (most recent call last):

instead of

Traceback: most recent call last

Note the parentheses and colon location. Thanks!

dfm avatar Jul 02 '24 14:07 dfm

Modified the traceback as suggested.

rajasekharporeddy avatar Jul 02 '24 14:07 rajasekharporeddy

Looks good - thanks!

dfm avatar Jul 02 '24 14:07 dfm