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

Correctly parse docblock comments #267

Closed
rizo opened this issue Dec 7, 2018 · 2 comments
Closed

Correctly parse docblock comments #267

rizo opened this issue Dec 7, 2018 · 2 comments

Comments

@rizo
Copy link
Collaborator

rizo commented Dec 7, 2018

Docblock is a common formatting of docstrings:

(**
 * Some comment
 *)

Currently odoc does not correctly parse this because of the leading * symbols. Although most OCaml libraries don’t use this style, I think it’s an unnecessary surprise for users who expect this to work.

@dbuenzli
Copy link
Contributor

Although most OCaml libraries don’t use this style, I think it’s an unnecessary surprise for users who expect this to work.

But if that is something that OCaml programmers manage to be consistent about, is it really worth introducing styling entropy by allowing this ?

@dbuenzli
Copy link
Contributor

dbuenzli commented Sep 1, 2019

As I said in my previous message since OCaml programmers are consistent about not doing this, I don't think it's a good idea to introduce this so I'm closing this.

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

No branches or pull requests

2 participants