Lwt: Update comments at the top of all code files

Created on 20 May 2017  Â·  2Comments  Â·  Source: ocsigen/lwt

The first three lines of .mli and .ml files in Lwt currently look like this (example):

(* Lightweight thread library for OCaml
 * http://www.ocsigen.org/lwt
 * (Module|Interface) Lwt

we want them to look like this (example):

(* OCaml promise library
 * http://www.ocsigen.org/lwt
  • "Lightweight thread" terminology is deprecated. We especially want to avoid it in .mli files, since people read those – though most people probably don't care about the file headers.
  • Repeating the module name (which is based on the file name) in the header is redundant and fragile.

The header for src/core/lwt.ml is already being changed in #354, but the rest need to be done.

docs easy

Most helpful comment

I'll work on this issue.

All 2 comments

I'll work on this issue.

Done in #376. Thanks @jsthomas!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

aantron picture aantron  Â·  9Comments

aantron picture aantron  Â·  8Comments

aantron picture aantron  Â·  5Comments

brendanlong picture brendanlong  Â·  5Comments

m4b picture m4b  Â·  4Comments