ocsigen / old.ocsigen.org

The old http://ocsigen.org/ website.
4 stars 3 forks source link

Error in Lwt_stream.​bounded_push documentation #25

Open Khady opened 8 years ago

Khady commented 8 years ago

In multiple function description the string Error a_api: "bounded_push" is not a valid module name is used instead of a correct type/value.

https://ocsigen.org/lwt/2.5.2/api/Lwt_stream.bounded_push-c

aantron commented 7 years ago

Ok, while debugging this, I found:

I can submit a PR, but to which project? IMO since wikidoc simply outputs the path that ocamldoc provides, we should change ocsigen.org to accept that syntax.

Drup commented 7 years ago

@aantron I would say it's better to fix wikidoc here, but honestly, do what is the easiest. ;)

aantron commented 7 years ago

Why?

It's easiest for me to fix wikidoc, because I can run it locally to test my work. But the fix would be replacing the last . by #, which IMO is the wrong thing to do for the long term. It's better to just be consistent about format. Since this error has not been reported before (apparently), I don't think I'll break anything by messing with ocsigen.org. So, as long as it's possible to deploy the fix with relative ease, I prefer to fix here. I'll submit a PR.

Drup commented 7 years ago

So, as long as it's possible to deploy the fix with relative ease

Yes, that's precisely what I'm worried about ... @vasilisp, @balat ?