Skip to content

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

Merged
merged 20 commits into from
Jul 20, 2022
Merged

Update README and documentation #499

merged 20 commits into from
Jul 20, 2022

Conversation

mkitti
Copy link
Collaborator

@mkitti mkitti commented Jul 12, 2022

Interpolations.jl documentation update

Changes so far

  • Rearranged and updated README.md
  • Update list of other packages
  • Update documentation badges
  • Update NEWS.md for 0.14 changes

To Do:

Fixes

Fixes #485

Preview of documentation:

@mkitti mkitti mentioned this pull request Jul 12, 2022
@codecov
Copy link

codecov bot commented Jul 12, 2022

Codecov Report

Merging #499 (87b427a) into master (5404e37) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #499   +/-   ##
=======================================
  Coverage   86.91%   86.91%           
=======================================
  Files          27       27           
  Lines        1819     1819           
=======================================
  Hits         1581     1581           
  Misses        238      238           
Impacted Files Coverage Δ
src/convenience-constructors.jl 100.00% <ø> (ø)

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 5404e37...87b427a. Read the comment docs.

Copy link
Collaborator Author

@mkitti mkitti left a 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]>
@ranocha
Copy link
Member

ranocha commented Jul 12, 2022

Thank you for your effort on improving and maintaining this nice package, @mkitti!

@PaulSoderlind
Copy link

README, Example now reads

xs = 1:0.2:5
f(x) = log(x)
A = [f(x) for x in xs]

Why not simplify to

xs = 1:0.2:5
A = log.(xs)

Copy link
Contributor

@ederag ederag left a 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.mdand 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.
Copy link
Contributor

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 and LinearInterpolators.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.

@mkitti mkitti force-pushed the mkitti/update_docs branch from 154c47c to 945425b Compare July 19, 2022 02:19
@mkitti
Copy link
Collaborator Author

mkitti commented Jul 19, 2022

I'm going to merge this after I get tests to pass so that I can move on to #501 .

@mkitti
Copy link
Collaborator Author

mkitti commented Jul 19, 2022

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.

@mkitti mkitti merged commit 4c29ad6 into master Jul 20, 2022
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.

Update Readme
4 participants