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

Top level README has outdated instructions for naming files in examples directory #256

Open
erichaney opened this issue Jan 15, 2025 · 2 comments

Comments

@erichaney
Copy link
Contributor

erichaney commented Jan 15, 2025

The "adding examples" section at the bottom of the document currently says that / should be replaced with _ in the file names added to the examples directory.

It should be updated to mention that any of the following characters %*/:<>? should be replaced with an underscore followed by their byte value (or whatever is the best way to phrase this).

See this document by sogaiu for a further discussion and concrete examples.

@sogaiu
Copy link
Collaborator

sogaiu commented Jan 19, 2025

At some point, perhaps it makes sense to add a script or some such to this repository that can be used to generate an appropriate example filename from a symbol name.

May be this would be more convenient (and less error-prone) for users and the instructions in the README would be simpler too?

@sogaiu
Copy link
Collaborator

sogaiu commented Jan 28, 2025

@erichaney Do you think that with the merging of #265 that this issue has been addressed?

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

2 participants