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

Fix String documentation #844

Open
thizanne opened this issue Mar 2, 2018 · 1 comment
Open

Fix String documentation #844

thizanne opened this issue Mar 2, 2018 · 1 comment

Comments

@thizanne
Copy link
Member

thizanne commented Mar 2, 2018

BatString documentation should be taken care of: there is no organisation, some functions are badly documented (right especially refers to left), and so on.

This is a big and ungrateful work, so let's just leave this issue open as a reminder. Maybe other modules could also benefit from some work, but String appeared as quite neglected as I was trying to find a function in the documentation.

@fccm
Copy link
Member

fccm commented Nov 19, 2020

The ocamldoc of String doesn't look that bad to me (I don't really see what should be improved).
This comment was written in 2018, so was it improved since then?
Only the functions that was switched to use the new bytes type should maybe have a deprecated tag added so that they could be removed in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants