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

Module descriptions should not appear in includes #87

Closed
lpw25 opened this issue Sep 18, 2017 · 0 comments
Closed

Module descriptions should not appear in includes #87

lpw25 opened this issue Sep 18, 2017 · 0 comments
Labels
bug Something isn't working output
Milestone

Comments

@lpw25
Copy link
Contributor

lpw25 commented Sep 18, 2017

When a module has a description comment:

(** This is the module that does foos *)
module Foo = struct
  val x : int
  ...
end

it gets included in the documentation of includes of that module:

include Foo

This is the module that does foos

val x : int

It probably shouldn't be since the comment describes the module itself rather than its contents, and if someone wants to know about Foo itself they can just follow the link and read about it.

@aantron aantron added the output label Apr 15, 2018
@aantron aantron added this to the 1.3.1 milestone Oct 25, 2018
@aantron aantron added the bug Something isn't working label Oct 25, 2018
jonludlam added a commit to jonludlam/odoc that referenced this issue Feb 22, 2019
Fixes ocaml#87

Also adds a test for this issue as well as one for Aliases as my first
attempt at this broke them.

Signed-off-by: Jon Ludlam <jon@recoil.org>
jonludlam added a commit to jonludlam/odoc that referenced this issue Feb 22, 2019
Fixes ocaml#87

Also adds a test for this issue as well as one for Aliases as my first
attempt at this broke them.

Signed-off-by: Jon Ludlam <jon@recoil.org>
aantron pushed a commit that referenced this issue Feb 22, 2019
Fixes #87

Also adds a test for this issue as well as one for Aliases as my first
attempt at this broke them.

Signed-off-by: Jon Ludlam <jon@recoil.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working output
Projects
None yet
Development

No branches or pull requests

2 participants