odoc

odoc copied to clipboard

Comments in object types are not rendered

2

The comments are not rendered in this example: ```ocaml type bar = < > type t = < foo : int; (** foo *) bar (** bar *) > ```

Julow

Doc strings get dropped on includes across compilation units.

4

Following up on https://github.com/ocaml/odoc/issues/875 it seems that comments do get lost on current master. Below the include in `B` has no docs. The include in `A` does. ``` > cat...

dbuenzli

Failure to expand complicated functor

1

The functor `App` in the following does not produce an expansion: ```ocaml module type Type = sig module type T end module App : functor (T : Type) (F :...

jonludlam

Hello, method types generated in documentation are incorrect, they include the implicit object parameter. For example, with the following definition: ```ocaml class foo = object method bar = 1 end...

zoggy

Reference to shadowed root modules

1

Root: ```ocaml module Foo : sig val x : int end module Bar : sig val x : int end ``` Test: ```ocaml module Root : sig module Foo :...

Julow

Reference a polymorphic variant constructor belonging to a type

1

Considering a polymorphic variant type: ```ocaml type switch = [`On; `Off] ``` I'd like to be able to refer to the constructors in the documentation. It could be doable if...

MisterDA

private type abbreviation becomes non-private when shadowed with an equal type

1

I put example code for this at https://github.com/leviroth/odoc-bug-demo. The crux of the example is that I have, in `p.mli`: ``` type t = private int module M : sig type...

leviroth

Markdown output

1

We would like to be able to render to a markdown document.

jonludlam

``` > echo "{0:sample OCaml 4.11.1 sample package documentation}" > frag.mld > odoc html-fragment frag.mld OCaml 4.11.1 sample package documentation ``` This breaks the `odig odoc --index-intro` option used e.g....

dbuenzli

The comment `bar` isn't rendered in this example: ```ocaml type bar = [ `Bar ] type t = [ `Foo (** foo *) | bar (** bar *) ] ```

Julow