Fix inconsistent methods syntax (read/write, get/set, etc.) #180
Labels
bug
Something isn't working
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
Under "storing/retrieving ensembles" in the demo, there's a mismatch between the code and the description (
qp.Ensemble.read_from
vs.qp.Ensemble.read
).Also, since the primary use case is RAIL, we should make a shortcut to opening a DataHandle directly without having to manually run it through tables_io. Perhaps this could be the difference between
read
/write
andread_from
/write_to
, whether it's just dealing with the raw qp.Ensemble or the DataHandle?EDIT: #192 covers a broader issue with
qp.Ensemble.ancil
but also has an example of.set()
without.get()
, which effectively has a totally different syntax of just.ancil()
. It would be a lot more intuitive to users if we were consistent about using or not using these pairs of common methods, and it might prevent some pathological behavior at the same time.The text was updated successfully, but these errors were encountered: