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.

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

Add more docstrings, and generate document by Documenter.jl #87

Merged
merged 25 commits into from Jan 11, 2021

Conversation

hyrodium
Copy link
Collaborator

@hyrodium hyrodium commented Jan 7, 2021

This PR is still draft, but mostly finished. (2021/01/09 update: unlock draft, ready to merge:tada:)
I've added the following.

  • more docstrings
  • more jldoctests
  • docs/src, docs/make.jland etc.

Sorry if my English is not correct.

docs/make.jl Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Jan 7, 2021

Codecov Report

Merging #87 (647c5df) into master (dca47a7) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #87   +/-   ##
=======================================
  Coverage   96.88%   96.88%           
=======================================
  Files           9        9           
  Lines        1123     1125    +2     
=======================================
+ Hits         1088     1090    +2     
  Misses         35       35           
Impacted Files Coverage Δ
src/besselroots.jl 93.02% <ø> (ø)
src/gausschebyshev.jl 100.00% <ø> (ø)
src/gausshermite.jl 100.00% <ø> (ø)
src/gaussjacobi.jl 99.27% <ø> (ø)
src/gausslegendre.jl 98.07% <ø> (ø)
src/gausslobatto.jl 100.00% <ø> (ø)
src/gaussradau.jl 100.00% <ø> (ø)
src/gausslaguerre.jl 92.93% <100.00%> (+0.04%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dca47a7...60c8d5b. Read the comment docs.

@MikaelSlevinsky
Copy link
Member

Thank you for preparing this contribution!

@hyrodium hyrodium marked this pull request as ready for review January 9, 2021 09:12
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
src/gausslaguerre.jl Outdated Show resolved Hide resolved
@hyrodium hyrodium mentioned this pull request Jan 9, 2021
@dlfivefifty dlfivefifty merged commit bd8857c into JuliaApproximation:master Jan 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants