Skip to content

Bring more clarity to tag #177

Open
Open
@lread

Description

@lread

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    High Priority (next release)

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions