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.

Sign up for GitHub

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

Jump to bottom

Documentation updates #476

Open
wants to merge 30 commits into
base: master
Choose a base branch
from
Open

Documentation updates #476

wants to merge 30 commits into from

Conversation

abhro
Copy link
Contributor

@abhro abhro commented Jul 1, 2024

  • Add DLMF reference identifiers
  • Add sections to API list
  • Clean up docstrings

abhro added 27 commits May 29, 2024 15:49
@abhro
Add reference links to functions
6599c59
@abhro
Move DLMF links in overview to paragraphs
4c22459 
In functions_overview.md, Documenter.jl picks up section headers
for permalinks. Move the links to their own paragraphs.
@abhro
Add import for installation
7fd2a3d
@abhro
Add DLMF section names to links
7f481d9 
Two links to DLMF share the same text, disambiguate
by using the sections they're pointing to.
@abhro
Remove redundant latex newline
62d01fa
@abhro
Fix indents
ccad58e
@abhro
Correct latex sequences
6997b79
@abhro
Add link text to bare urls
e5ab828
@abhro
Wrap lines
5677bff
@abhro
Change latex sequence
c307c27
@abhro
Update spacing
3b91248
@abhro
Refactor links to Base
a3e3a7e
@abhro
Mark code syntax
c4e52b5
@abhro
Add equation/section numbers to DLMF links
5d5ab3f 
The equation number in the anchor text helps more
easily identify links, and can help in navigation.

TODO: do something for the Wikipedia links?
@abhro
Fix exponent notation in LaTeX
ab80d66
@abhro
Add DOI to reference
fb02fc0
@abhro
Fix spacing
e26f6d3
@abhro
Use raw_str for latex containing docstrings
7b9c818
@abhro
Fix indent
a5c8858
@abhro
Split method docstrings for erf
71f7e42
@abhro
Add backticks
11da6be
@abhro
Add doc raw"" for easier LaTeX escaping
6727d68
@abhro
Use subscripts in latex
e72babf
@abhro
Remove redundant \operatorname
991870f 
Most TeX engines recognize \ln and \log
@abhro
Fix backtick and backslash use
cc17155
@abhro
Remove asterisk stars from tex
50576c5
@abhro
Add sections to function list
5a6856c
@codecov Codecov
Copy link

codecov bot commented Jul 1, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.10%. Comparing base (c400278) to head (db0d3c3).

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
Flag Coverage Δ
unittests 94.10% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@abhro abhro marked this pull request as draft July 1, 2024 19:22
@abhro
Partial revert of 71f7e42
e0e6443 
Remove `erf(::Real)` method used for docstring, and add
`erf(::Real, ::Real)` for docs page
giordano
giordano reviewed Jul 1, 2024
View reviewed changes
docs/src/functions_list.md Outdated Show resolved Hide resolved
giordano
giordano reviewed Jul 1, 2024
View reviewed changes
src/sincosint.jl Outdated Show resolved Hide resolved
@abhro abhro marked this pull request as ready for review July 1, 2024 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@giordano giordano giordano left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@abhro @giordano