search

JuliaMath / Interpolations.jl

Fast, continuous interpolation of discrete datasets in Julia
http://juliamath.github.io/Interpolations.jl/
Other
518 stars 110 forks source link

Minor overhaul of markdown docs and docstrings #591

Closed abhro closed 3 months ago

abhro commented 4 months ago

If stayed indented, Documenter.jl picks it all up as code sample and displays monospace. Moreover, the actual code sample/examples are not recognized.

abhro commented 4 months ago

The doctests fail because using Interpolations isn't run for the doctests. Should that be handled in the docstrings or elsewhere in the repo?

abhro commented 4 months ago

Sorry, turns out renaming a branch closes the pull request.

codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 73.91304% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 87.07%. Comparing base (c7e2d45) to head (c86d58e).

Files Patch % Lines
src/hermite/cubic.jl 50.00% 4 Missing :warning:
src/Interpolations.jl 0.00% 1 Missing :warning:
src/scaling/scaling.jl 75.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #591 +/- ## ========================================== - Coverage 87.17% 87.07% -0.10% ========================================== Files 28 28 Lines 1887 1888 +1 ========================================== - Hits 1645 1644 -1 - Misses 242 244 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mkitti commented 4 months ago

Hmm... let me see what I can do here.

mkitti commented 3 months ago

I'm good to merge this. Is it ready?

abhro commented 3 months ago

Yes, it should be. Thank you!