update docstrings #201
Merged
update docstrings #201
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
AshtonSBradley
commented
Jan 7, 2020
AshtonSBradley
commented
- consistent order of External links and See also
- minor clarifications for ellipk/ellipe regarding domain of argument.
Co-Authored-By: Simon Byrne <simonbyrne@gmail.com>
Co-Authored-By: Simon Byrne <simonbyrne@gmail.com>
Co-Authored-By: Simon Byrne <simonbyrne@gmail.com>
Co-Authored-By: Simon Byrne <simonbyrne@gmail.com>
Co-Authored-By: Simon Byrne <simonbyrne@gmail.com>
Co-Authored-By: Simon Byrne <simonbyrne@gmail.com>
Co-Authored-By: Simon Byrne <simonbyrne@gmail.com>
Co-Authored-By: Simon Byrne <simonbyrne@gmail.com>
Co-Authored-By: Simon Byrne <simonbyrne@gmail.com>
Co-Authored-By: Simon Byrne <simonbyrne@gmail.com>
simonbyrne
reviewed
Jan 7, 2020
src/ellip.jl
Outdated
| @@ -15,14 +15,13 @@ Computes Complete Elliptic Integral of 1st kind ``K(m)`` for parameter ``m`` giv | |||
| \quad \text{for} \quad m \in \left( -\infty, 1 \right] \, . | |||
| ``` | |||
|
|
|||
| External links: [DLMF](https://dlmf.nist.gov/19.2#E8), | |||
| [Wikipedia](https://en.wikipedia.org/wiki/Elliptic_integral#Notational_variants). | |||
| External links: [DLMF](https://dlmf.nist.gov/19.2#E8), [Wikipedia](https://en.wikipedia.org/wiki/Elliptic_integral#Notational_variants). | |||
There was a problem hiding this comment.
You can link to DLMF via X.Y.Z format:
Suggested change
| External links: [DLMF](https://dlmf.nist.gov/19.2#E8), [Wikipedia](https://en.wikipedia.org/wiki/Elliptic_integral#Notational_variants). | |
| External links: [DLMF 19.2.8](https://dlmf.nist.gov/19.2.8), [Wikipedia](https://en.wikipedia.org/wiki/Elliptic_integral#Notational_variants). |
simonbyrne
reviewed
Jan 7, 2020
src/ellip.jl
Outdated
| @@ -191,14 +190,13 @@ Computes Complete Elliptic Integral of 2nd kind ``E(m)`` for parameter ``m`` giv | |||
| \quad \text{for} \quad m \in \left( -\infty, 1 \right] \, . | |||
| ``` | |||
|
|
|||
| External links: [DLMF](https://dlmf.nist.gov/19.2#E8), | |||
| [Wikipedia](https://en.wikipedia.org/wiki/Elliptic_integral#Complete_elliptic_integral_of_the_second_kind). | |||
| External links: [DLMF](https://dlmf.nist.gov/19.2#E8), [Wikipedia](https://en.wikipedia.org/wiki/Elliptic_integral#Complete_elliptic_integral_of_the_second_kind). | |||
There was a problem hiding this comment.
Suggested change
| External links: [DLMF](https://dlmf.nist.gov/19.2#E8), [Wikipedia](https://en.wikipedia.org/wiki/Elliptic_integral#Complete_elliptic_integral_of_the_second_kind). | |
| External links: [DLMF 19.2.8](https://dlmf.nist.gov/19.2.8), [Wikipedia](https://en.wikipedia.org/wiki/Elliptic_integral#Complete_elliptic_integral_of_the_second_kind). |
|
i've updated all DLMF links to X.Y.Z form |
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.