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

Incorrect docstrings for several Containers modules (CCList, CCString, CCArray) #323

Closed
Fourchaux opened this issue Jul 21, 2020 · 6 comments
Labels

Comments

@Fourchaux
Copy link
Contributor

See: OCamlPro/ocp-index#143

@c-cube
Copy link
Owner

c-cube commented Jul 22, 2020

is it to be solved on ocp-index side, or ours? I'm not sure what causes this

@Fourchaux
Copy link
Contributor Author

Waiting for a response from the pros of OCamlPro !!!

Actually, it seems almost all imported functions (with the include/open Foo) are displaying a wrong docstring.
Pb with ocp-index?
What is a bit annoying is the different behavior of Containers_opam and Containers_dev.

BTW, you are using (in Containers_dev) open CCShims_ and also include CCShims_ (in CCArray). It's different, isn't it?

@c-cube
Copy link
Owner

c-cube commented Jul 22, 2020

well include is for re-exporting, open just because it's convenient to have the more modern functions sometimes.

@Fourchaux
Copy link
Contributor Author

Fourchaux commented Jul 23, 2020

The problem is not specific to Containers. Ouf...

I changed the title and the examples of OCamlPro/ocp-index#143

Wait and See.

@c-cube
Copy link
Owner

c-cube commented Dec 9, 2020

is this still an issue?

@Fourchaux
Copy link
Contributor Author

Yes, still an issue.

@AltGr 's last comment:
OCamlPro/ocp-index#143

This issue is not specific to Containers, you could possibly close it.

@c-cube c-cube added the invalid label Dec 9, 2020
@c-cube c-cube closed this as completed Dec 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants