DOC: Changed vdot docs as suggested #26406
Conversation
|
Thanks for the ping, @geetaakshata! Can you have the text "Frobenius inner product" link to https://en.wikipedia.org/wiki/Frobenius_inner_product? I'm not sure what syntax would be used to create the external link. You might need to look at source code for other NumPy web documentation to figure that out. |
|
Ah, the age-old question: how do you make a hyperlink in sphinx? Only the sages know 😜 Kidding but not really, it's the most common sphinx issue people run into. Relevant StackOverflow answer, which links to the ReStructuredText docs: https://stackoverflow.com/questions/17189038/generating-an-external-link-in-sphinx |
|
Also numpy's linter enforces a 79 character line limit, see the test results. |
|
@geetaakshata could you relate to the review comments? You can add another commit to the current code:
Note that using a non-unique branch like |
|
@geetaakshata is this still active? |
| @@ -842,18 +842,22 @@ def dot(a, b, out=None): | |||
|
|
|||
| @array_function_from_c_func_and_dispatcher(_multiarray_umath.vdot) | |||
| def vdot(a, b): | |||
| """ | |||
| r""" | |||
There was a problem hiding this comment.
Probably not needed after all.
| @@ -894,7 +898,7 @@ def vdot(a, b): | |||
| >>> 1*4 + 4*1 + 5*2 + 6*2 | |||
| 30 | |||
|
|
|||
| """ | |||
| """ # noqa: E501 | |||
There was a problem hiding this comment.
Only needed for the URL. Perhaps Sphinx would allow a line break there, but I wasn't sure.
|
@ngoldbaum @mattip I added a commit to address the comments, then realized I'd need to merge main to get CircleCI to run. Looks like I added an extra period, though. LMK if you'd want all this rebased or if it's OK to just squash merge (after committing the removal of the period). macOS tests failure seems unrelated (same failure in gh-27544). |
Co-authored-by: Matt Haberland <mhaberla@calpoly.edu>
|
Thanks @geetaakshata and @mdhaber |
Closes gh-26342