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

Stdlib documentation #339

Merged
merged 29 commits into from
Sep 3, 2024
Merged

Stdlib documentation #339

merged 29 commits into from
Sep 3, 2024

Conversation

Mte90
Copy link
Member

@Mte90 Mte90 commented Jul 23, 2024

Ref: amber-lang/amber-docs#38

I need a bit of help to improve the documentation also because I didn't understood the purpose of some function.

I think that @CymDeveloppement can help me about it as some of them are by him.

@Mte90 Mte90 added the documentation Improvements or additions to documentation label Jul 23, 2024
src/std/text.ab Show resolved Hide resolved
src/std/fs.ab Outdated Show resolved Hide resolved
src/std/fs.ab Outdated Show resolved Hide resolved
src/std/text.ab Show resolved Hide resolved
src/std/text.ab Show resolved Hide resolved
src/std/env.ab Show resolved Hide resolved
src/std/env.ab Outdated Show resolved Hide resolved
src/std/env.ab Outdated Show resolved Hide resolved
src/std/env.ab Outdated Show resolved Hide resolved
src/std/fs.ab Outdated Show resolved Hide resolved
src/std/fs.ab Outdated Show resolved Hide resolved
src/std/text.ab Show resolved Hide resolved
src/std/env.ab Outdated Show resolved Hide resolved
src/std/env.ab Outdated Show resolved Hide resolved
src/std/env.ab Outdated Show resolved Hide resolved
src/std/env.ab Outdated Show resolved Hide resolved
src/std/env.ab Outdated Show resolved Hide resolved
src/std/array.ab Outdated Show resolved Hide resolved
src/std/array.ab Outdated Show resolved Hide resolved
src/std/array.ab Outdated Show resolved Hide resolved
src/std/env.ab Show resolved Hide resolved
src/std/env.ab Outdated Show resolved Hide resolved
src/std/text.ab Outdated Show resolved Hide resolved
src/std/text.ab Outdated Show resolved Hide resolved
src/std/text.ab Outdated Show resolved Hide resolved
src/std/text.ab Outdated Show resolved Hide resolved
src/std/text.ab Outdated Show resolved Hide resolved
Mte90 and others added 6 commits July 23, 2024 15:56
Co-authored-by: Hubert Jabłoński <[email protected]>
Co-authored-by: Hubert Jabłoński <[email protected]>
Co-authored-by: Hubert Jabłoński <[email protected]>
Co-authored-by: Hubert Jabłoński <[email protected]>
Co-authored-by: Hubert Jabłoński <[email protected]>
src/std/env.ab Outdated Show resolved Hide resolved
Mte90 and others added 6 commits July 23, 2024 15:57
Co-authored-by: Hubert Jabłoński <[email protected]>
Co-authored-by: Hubert Jabłoński <[email protected]>
Co-authored-by: Hubert Jabłoński <[email protected]>
Co-authored-by: Hubert Jabłoński <[email protected]>
Co-authored-by: Hubert Jabłoński <[email protected]>
Co-authored-by: Hubert Jabłoński <[email protected]>
@Mte90 Mte90 dismissed CymDeveloppement’s stale review July 25, 2024 09:19

we will discuss in a ticket about the error handling

@Mte90

This comment was marked as outdated.

Copy link
Member

@Ph0enixKM Ph0enixKM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay I see now. Let's wait for the PR first

@Mte90 Mte90 marked this pull request as ready for review August 30, 2024 15:15
@Mte90 Mte90 dismissed Ph0enixKM’s stale review August 30, 2024 15:16

I removed the part that create the dependency cycle so we can merge the documentation in the meantime

@Mte90 Mte90 requested review from KrosFire, mks-h and b1ek August 30, 2024 16:12
@Mte90
Copy link
Member Author

Mte90 commented Aug 30, 2024

So it is ready to get approved :-)

@b1ek
Copy link
Member

b1ek commented Aug 31, 2024

what about the #360? i dont think that has been addressed yet

@Mte90
Copy link
Member Author

Mte90 commented Aug 31, 2024

Now the PR is free from that issue as I removed the code (the CI works).
In this way we can merge it and do the new release as there is no blockers.
We implemented too many things in this alpha.
When that will be implemented we can improve the stdlib code reusing stuff in the various files.

@Ph0enixKM
Copy link
Member

I'm still not a big fan of having the len function in a std/text module and nothing like that in std/array module as it works for both text and arrays. How about creating std/core that has the len function and perhaps some more of the most core and atomic functions? @Mte90 @b1ek @KrosFire

@Mte90
Copy link
Member Author

Mte90 commented Sep 2, 2024

I think that can create confusion.
Usually is a native function in a script language, I think that we can keep as it is now and later move as builtin.

@KrosFire
Copy link
Member

KrosFire commented Sep 2, 2024

I'm still not a big fan of having the len function in a std/text module and nothing like that in std/array module as it works for both text and arrays. How about creating std/core that has the len function and perhaps some more of the most core and atomic functions? @Mte90 @b1ek @KrosFire

Let's move it to separate issue. I think that std/core or something like that is a good idea

Copy link
Member

@Ph0enixKM Ph0enixKM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good

@Ph0enixKM Ph0enixKM merged commit abfb15f into amber-lang:master Sep 3, 2024
1 check passed
Mte90 added a commit to Mte90/Amber that referenced this pull request Sep 19, 2024
* feat(doc): stdlib first incomplete version

* feat(doc): stdlib first incomplete version

* feat(review): by @CymDeveloppement

* feat(review): by @CymDeveloppement

* Update src/std/array.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/text.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/text.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/text.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/env.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/env.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/fs.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/fs.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/http.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/text.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/text.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* Update src/std/text.ab

Co-authored-by: Hubert Jabłoński <[email protected]>

* feat(review): by @KrosFire

* feat(review): by @KrosFire

* feat(review): text and remove in_array

* feat(review): by @CymDeveloppement

* fix(std): remove dependence so we can merge the documentation in the meantime

* fix(test): wip

* fix(test): wip

* fix(test): wip

* fix(test): wip

* fix(test): wip

* Update text.ab

---------

Co-authored-by: Hubert Jabłoński <[email protected]>
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

Successfully merging this pull request may close these issues.

5 participants