pynhd icon indicating copy to clipboard operation
pynhd copied to clipboard

consistent naming convention in API

Open ecoon opened this issue 3 months ago • 1 comments

Is your feature request related to a problem?

It would be nice to have a consistent API naming convention across the various data access classes. Specifically:

https://github.com/hyriver/pynhd/blob/main/src/pynhd/pynhd.py#L727 --> WaterData.byid()

vs.

https://github.com/hyriver/pynhd/blob/main/src/pynhd/core.py#L224 --> AGRBase.byids() (e.g. NHD, NHDPlusHR, etc)

I'm fairly sure that the semantics are the same (e.g. both accept a list of IDs, not just a single ID).

Describe the solution you'd like

Change WaterData.byid() --> WaterData.byids() to match others.

Describe alternatives you've considered

No response

Additional context

I haven't seen any other instances of byid() in hyriver, but probably a quick grep would check to allow making them all consistent across the project. Nice work by the way!

ecoon avatar Nov 08 '24 15:11 ecoon