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

Add documentation on builtin types and functions #453

Closed
developedby opened this issue May 22, 2024 · 1 comment · Fixed by #492
Closed

Add documentation on builtin types and functions #453

developedby opened this issue May 22, 2024 · 1 comment · Fixed by #492
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@developedby
Copy link
Member

Is your feature request related to a problem? Please describe.
Currently builtins are each explained in documentation (lists, strings, etc), but there is nowhere that actually lists all the builtins and explains what they are for.
Everything is sort of hidden in builtins.bend.

Describe the solution you'd like
A document explaining each builtin.

Describe alternatives you've considered
Somehow making builtins.bend accessible for users, like automatically generating documentation from programs ala doxygen, docs.rs, etc.

Additional context
Users have complained about this.
There's actually hidden features in the builtins (maps).

@developedby developedby added documentation Improvements or additions to documentation enhancement New feature or request labels May 22, 2024
@Sipher Sipher self-assigned this May 24, 2024
@Sipher
Copy link
Member

Sipher commented May 24, 2024

Wrote a .md file to help out, not sure where to add in the Readme,will send a PR if enjoyed and if necessary I can edit the file.

Here's a gist for a temp file at least:

https://gist.github.com/Sipher/088d26319f70745c2c5144f9ff3667e7

If you don't like it I can just redo or undo

@Sipher Sipher linked a pull request May 24, 2024 that will close this issue
@Sipher Sipher closed this as completed May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants