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

[Bug] Docs: link to standard library documentation missing #31

Closed
klausi opened this issue Jun 20, 2024 · 5 comments
Closed

[Bug] Docs: link to standard library documentation missing #31

klausi opened this issue Jun 20, 2024 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@klausi
Copy link
Contributor

klausi commented Jun 20, 2024

Hi,

I want to convert text output from a command into an array. The doc page at https://docs.amber-lang.com/basic_syntax/arrays talks about a standard library documentation, do you know where it is?

@CymDeveloppement
Copy link
Member

To my knowledge the documentation does not exist.
but you can use
split(text: Text, delimiter: Text): [Text], lines(text: Text): [Text] and words(text: Text): [Text]
standard library is here : https://github.com/Ph0enixKM/Amber/blob/master/src/std/main.ab

@klausi
Copy link
Contributor Author

klausi commented Jun 24, 2024

Thanks, found the better lines() function and used it for https://docs.amber-lang.com/by_example/bot_detector

Leaving this open for now to update the docs and link to the standard library directly for now until there are proper docs for them.

@Mte90 Mte90 added the documentation Improvements or additions to documentation label Jun 24, 2024
@Ph0enixKM Ph0enixKM changed the title Docs: link to standard library documentation missing [Bug] Docs: link to standard library documentation missing Jul 7, 2024
@Mte90 Mte90 self-assigned this Jul 9, 2024
@Mte90 Mte90 transferred this issue from amber-lang/amber Jul 18, 2024
@Mte90
Copy link
Member

Mte90 commented Jul 23, 2024

With amber-lang/amber#339 the documentation can be generated with Amber itself.
We need to find a way to generate it for this website.

@Mte90
Copy link
Member

Mte90 commented Jul 23, 2024

To proceed with this task:

  • Create a page on https://docs.amber-lang.com/basic_syntax/ about stdlib
  • Create a Amber script that downloads the latest Amber version, compile it, loop the various files in /stdlib/ folder to generate the documentation and put in the right folder

What do you think @Ph0enixKM?

@Mte90
Copy link
Member

Mte90 commented Sep 5, 2024

Fix #39

I am closing as that issue is mentioned in other tickets that waits that PR.

@Mte90 Mte90 closed this as completed Sep 5, 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
Projects
None yet
Development

No branches or pull requests

3 participants