Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upThere is no way to set the whole-module comment for a text #7333
Comments
This comment has been minimized.
This comment has been minimized.
|
Comment author: @Octachron Using the first sentence as a short description/global module comment for text |
This comment has been minimized.
This comment has been minimized.
|
Comment author: @gasche The proposed PR has been merged in trunk -- will not be part of the 4.04 release, but of the upcoming one. Thanks! |
vicuna
closed this
Aug 31, 2016
vicuna
added
the
ocamldoc
label
Mar 14, 2019
vicuna
assigned
gasche
Mar 14, 2019
vicuna
added
the
feature-wish
label
Mar 20, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
vicuna commentedAug 23, 2016
Original bug ID: 7333
Reporter: gerd
Assigned to: @gasche
Status: resolved (set by @gasche on 2016-08-31T20:36:57Z)
Resolution: fixed
Priority: low
Severity: feature
Version: 4.02.3
Fixed in version: 4.05.0 +dev/beta1/beta2/beta3/rc1
Category: ocamldoc
Monitored by: @gasche
Bug description
Imagine ocamldoc is called with a text file (.txt, or -text file). The file appears in the generated global overview of the modules documented, but the description remains empty. For normal mli files, the whole-module comment is simply the first sentence. The suggestion is to also use the first sentence of text files as whole-module comment.