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 table to documentation of module functions #85

Open
jjg-123 opened this issue Oct 25, 2024 · 1 comment
Open

Add table to documentation of module functions #85

jjg-123 opened this issue Oct 25, 2024 · 1 comment

Comments

@jjg-123
Copy link
Collaborator

jjg-123 commented Oct 25, 2024

Since some people do not use the workspace ever, their only source of information is, apparently, the reference manual. Add an appendix (?) of functions per module. Basically just run (e.g. for strings)

)funcs system -fq -r ^string.* -cols
string#contains([2,3])
string#detokenize([2,3])
string#differ_at([2])
string#from_uri([1])
string#head([2,3])
string#index_of([2,3])
string#insert([3])
string#replace([2,3,4])
string#substring([1,2,3,4])
string#tail([2,3])
string#to_lower([1])
string#to_upper([1])
string#to_uri([1,2])
string#tokenize([2,3])
string#trim([1])
15 total functions

and put the results, sans qualification, in a table with a one-line description.

@jjg-123
Copy link
Collaborator Author

jjg-123 commented Oct 29, 2024

Even better, put it in the function reference. Have a section listing functions by module.

@jjg-123 jjg-123 changed the title Add table to documentation of moduel fuctions Add table to documentation of module functions Nov 5, 2024
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

1 participant