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

Expose example filename creation via script #265

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sogaiu
Copy link
Collaborator

@sogaiu sogaiu commented Jan 19, 2025

For background and motivation, please see this comment.

This PR is a suggestion to address #256 by:

  1. Exposing the ability to generate a suitable examples directory filename for a Janet symbol via a script
  2. Updating the "Adding Examples" section of the README to explain how to use the script

As part of point 1 above, a portion of content/api/gen-docs.janet was relocated to a new file named content/api/examples.janet. This latter file also contains a main entry point for use from the command line.

Use of the new script is also described in the udpated README, but a concrete invocation example is:

$ janet content/api/examples.janet array/new

which should yield the output:

array_47new.janet

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

Successfully merging this pull request may close these issues.

1 participant