-
Notifications
You must be signed in to change notification settings - Fork 113
Update README and documentation #499
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
Conversation
Codecov Report
@@ Coverage Diff @@
## master #499 +/- ##
=======================================
Coverage 86.91% 86.91%
=======================================
Files 27 27
Lines 1819 1819
=======================================
Hits 1581 1581
Misses 238 238
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the edits @ranocha !
Co-authored-by: Hendrik Ranocha <[email protected]>
Thank you for your effort on improving and maintaining this nice package, @mkitti! |
README, Example now reads
Why not simplify to
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unless one of them is automatically generated from the other,
maybe ditch docs/src/other_packages.md
and just link to the
"Other Interpolation Packages" section of the README.md
?
README.md
Outdated
- [LinearInterpolators.jl](https://github.com/emmt/LinearInterpolators.jl) provides linear interpolation methods for Julia based on InterpolationKernels.jl, below. | ||
- [LinearInterpolations.jl](https://github.com/jw3126/LinearInterpolations.jl) allows for interpolation using weighted averages allowing probability distributions, rotations, and other Lie groups to be interpolated. | ||
- [LocalFunctionApproximation.jl](https://github.com/sisl/LocalFunctionApproximation.jl) provides local function approximators that interpolates a scalar-valued function across a vector space. | ||
- [InterpolationKernels.jl](https://github.com/emmt/InterpolationKernels.jl) provides a library of interpolation kernels. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems the list is meant to be in alphabetical order.
If indeed the case, then
- this should be moved upwards, between
KissSmoothing.jl
andLinearInterpolators.jl
- the
LinearInterpolators.jl
line should then end with "...based on InterpolationKernels.jl, above."
(rather than "below")
The same fix should apply to docs/src/other_packages.md
.
…ons.jl into mkitti/update_docs
Co-authored-by: ederag <[email protected]>
Co-authored-by: ederag <[email protected]>
154c47c
to
945425b
Compare
I'm going to merge this after I get tests to pass so that I can move on to #501 . |
Thank you for everyone's help! I'm going to merge this now. Feel free to open more pull requests if you notice any other issues. |
Interpolations.jl documentation update
Changes so far
To Do:
Fixes
Fixes #485
Preview of documentation: