The naming of rewrite-clj.zip/edn is misleading
lread opened this issue · 0 comments
lread commented
Problem/Opportunity
The rewrite-clj zip API has the non-intuitively and inconsistently named edn
and edn*
functions.
The functions convert/load rewrite-clj nodes to zippers.
This makes them hard to discover and perhaps confusing.
Proposed Solution
Add aliases that match the existing well-named of-string
and of-file
: of-node
and of-node*
.
Deprecate edn
and edn*
to promote usage of more meaningful named functions.
Alternative Solutions
I can't think of any off-hand.
Additional context
Thanks for @borkdude for the idea!
Action
I'll double-check that these functions really only work with rewrite-clj nodes.
And then I'll follow up with a PR that covers code, docs, and tests.