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

Bring more clarity to tag #177

Open
lread opened this issue May 23, 2022 · 2 comments
Open

Bring more clarity to tag #177

lread opened this issue May 23, 2022 · 2 comments
Labels

Comments

@lread
Copy link
Collaborator

lread commented May 23, 2022

The user guide and docstrings are vague around valid values for tag.

Abbreviated from chat with @NoahTheDuke on Slack:

Noah:

can the docs list the node types and give examples of given input to create one? There’s the Reader Macro Chars list but that's about how sexpr renders it. For an example of the potential confusion, I would naively expect that true/false/nil aren't “token” types, but they are.

Me:

Do you mean the type returned by the node’s tag?

Noah:

Yes, the keyword returned by the function rewrite-clj.node. A list of possible tags (and some description and inputs) would be very helpful.

Me:

Yeah I agree, that is part of the public interface but maybe not documented very well and maybe only incidentally mentioned. So I’m thinking the user guide and docstrings need a little updating.

@lread lread added the docs label May 23, 2022
@borkdude
Copy link
Collaborator

Related: #114 (comment)

@lread
Copy link
Collaborator Author

lread commented May 27, 2022

Ok, no wonder I didn't go into details for this in the user guide.
It means describing something that is pretty awkward to use without custom helpers.
I think tackling #114 first and then documenting makes more sense than documenting current type interrogators.

@lread lread added this to rewrite-clj Jul 3, 2024
@lread lread moved this to High Priority (next release) in rewrite-clj Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: High Priority (next release)
Development

No branches or pull requests

2 participants