Documentation updates #476
Merged
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
abhro
commented
Jul 1, 2024
abhro
commented
- Add DLMF reference identifiers
- Add sections to API list
- Clean up docstrings
In functions_overview.md, Documenter.jl picks up section headers for permalinks. Move the links to their own paragraphs.
Two links to DLMF share the same text, disambiguate by using the sections they're pointing to.
The equation number in the anchor text helps more easily identify links, and can help in navigation. TODO: do something for the Wikipedia links?
Most TeX engines recognize \ln and \log
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #476 +/- ##
=======================================
Coverage 94.10% 94.10%
=======================================
Files 14 14
Lines 2935 2935
=======================================
Hits 2762 2762
Misses 173 173
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Remove `erf(::Real)` method used for docstring, and add `erf(::Real, ::Real)` for docs page
giordano
reviewed
Jul 1, 2024
giordano
reviewed
Jul 1, 2024
|
This broadly looks great. Merging it. |
|
@abhro May I request you to see the deployed docs on the dev branch to see if it all looks good? Thanks for the cleanup PR! |
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.