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

Libraries page improvement #28

Merged
merged 9 commits into from
Sep 11, 2020
Merged

Conversation

Andre-LA
Copy link
Contributor

@Andre-LA Andre-LA commented Sep 10, 2020

Adding the vector library to the Libraries page (copied from the code comments)

Preview: https://andre-la.github.io/nelua-lang/libraries/

@edubart
Copy link
Owner

edubart commented Sep 10, 2020

It's interesting to add fields also, like

| vectorT.size: usize | Number of the elements in the vector. |
| vectorT.data: span(T) | Elements storage of the vector. |
| vectorT.allocator | Allocator of the vector. |

@Andre-LA
Copy link
Contributor Author

Andre-LA commented Sep 10, 2020

should _grow also be added?
Edit: nevermind, just noticed that internal functions are documented on filestream

@Andre-LA Andre-LA changed the title Add vector functions on libraries page (WIP): Libraries page improvement Sep 10, 2020
@edubart
Copy link
Owner

edubart commented Sep 10, 2020

@Andre-LA Don't add internal functions, I will remove those from the docs, internal functions are implementation details that can change often and should be avoided.

@edubart
Copy link
Owner

edubart commented Sep 11, 2020

Looks good, once you mark as non draft I will merge.

* Describe `arg` as a sequence;

* Formatting fix on `filestream.open`;

* only using nelua syntax on expressions on descriptions;

* Add more context on math compile-time values.
@Andre-LA Andre-LA marked this pull request as ready for review September 11, 2020 18:42
@Andre-LA
Copy link
Contributor Author

Andre-LA commented Sep 11, 2020

Done :)
(I did some changes arg's and math's compile-time values descriptions on commit 61c0016)

@edubart edubart merged commit 98da4e4 into edubart:master Sep 11, 2020
@edubart
Copy link
Owner

edubart commented Sep 11, 2020

Thanks, merged!

@Andre-LA Andre-LA deleted the docs-libraries/vector branch October 17, 2020 23:28
@edubart edubart changed the title (WIP): Libraries page improvement Libraries page improvement Dec 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants