search

jmert / AssociatedLegendrePolynomials.jl

A library for calculating the Associated Legendre polynomials
https://jmert.github.io/AssociatedLegendrePolynomials.jl/
MIT License
20 stars 2 forks source link

Rename this package from Legendre to AssociatedLegendrePolynomials #30

Closed jmert closed 2 years ago

jmert commented 2 years ago

As preparation for registering this package in the General repository, we need to make the name a bit more specific. Therefore, this PR implements changing the name from Legendre to LegendrePolynomials AssociatedLegendrePolynomials.

TODO:

Towards #28.

codecov[bot] commented 2 years ago

Codecov Report

Merging #30 (59f4c01) into master (74d2d37) will decrease coverage by 0.02%. The diff coverage is 100.00%.

:exclamation: Current head 59f4c01 differs from pull request most recent head bbeb8e3. Consider uploading reports for the commit bbeb8e3 to get more accurate results Impacted file tree graph

@@            Coverage Diff             @@
##           master      #30      +/-   ##
==========================================
- Coverage   96.57%   96.54%   -0.03%     
==========================================
  Files           9        9              
  Lines         350      347       -3     
==========================================
- Hits          338      335       -3     
  Misses         12       12
Impacted Files Coverage Δ
src/AssociatedLegendrePolynomials.jl 100.00% <100.00%> (ø)
src/norm_sphere.jl 97.14% <0.00%> (-0.23%) :arrow_down:

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 74d2d37...bbeb8e3. Read the comment docs.

jmert commented 2 years ago

Snag in this plan is that there appears to already be a registered LegendrePolynomials package: https://github.com/JuliaRegistries/General/tree/master/L/LegendrePolynomials

Maybe AssociatedLegendrePolynomials? That's getting to be a long name, but it technically is more accurate and something that this package provides that the registered package does not.

jakebolewski commented 2 years ago

Thanks @jmert! I think AssociatedLegendrePolynomials makes sense as a name, I wouldnt worry about the length as long as it is specific.

x-ref: https://github.com/CliMA/ClimaCore.jl/pull/313