Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The naming of rewrite-clj.zip/edn is misleading #178

Closed
lread opened this issue Jun 2, 2022 · 0 comments
Closed

The naming of rewrite-clj.zip/edn is misleading #178

lread opened this issue Jun 2, 2022 · 0 comments

Comments

@lread
Copy link
Collaborator

lread commented Jun 2, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant