API Audit - Githubissues

creare-com / podpac

Pipeline for Observational Data Processing Analysis and Collaboration

https://podpac.org

Apache License 2.0

45 stars 6 forks source link

API Audit #503

Closed CFoye-Creare closed 1 year ago

CFoye-Creare commented 1 year ago

Running tests after changing all appropriate modules to plural.

CFoye-Creare commented 1 year ago

merging from develop undid previous changes. reinstating refactoring of modules.

CFoye-Creare commented 1 year ago

All tests that should pass do.

mpu-creare commented 1 year ago

@CFoye-Creare Could you please write a new documentation entry explaining the style that we've chosen.

A few comments:

Seems like some modules you renamed from singular to plural (algorithm -> algorithms), but others you did not (interpolation -> interpolator)
Seems like you did not audit all the Node names to make sure they are singular nouns (see discussion in #427)

mpu-creare commented 1 year ago

Also, I think the version module should be an exception? It should be singular, because that seems to be the common convention across Python libraries. @jxm, care to weigh in?

CFoye-Creare commented 1 year ago

I renamed modules inside podpac. to plural, but changed modules inside podpac.. to singular. So, podpac.interpolator.py became podpac.interpolators.py while podpac.interpolation.interpolator.interpolator.py was kept singular. Want me to change `podpac.interpolation.topodpac.interpolator`?