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

There is no way to set the whole-module comment for a text #7333

Closed
vicuna opened this issue Aug 23, 2016 · 2 comments

Comments

Projects
None yet
2 participants
@vicuna
Copy link

commented Aug 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.

@vicuna

This comment has been minimized.

Copy link
Author

commented Aug 28, 2016

Comment author: @Octachron

Using the first sentence as a short description/global module comment for text
files sounds like a good compromise. Moreover, the implementation seems quite short, cf. #784.

@vicuna

This comment has been minimized.

Copy link
Author

commented Aug 31, 2016

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.