Skip to content

Commit 8964ebb

Browse files
jorisgiojonludlam
authored andcommitted
odoc_for_author: document top-level attributes being ignored for top comments extraction
1 parent 8518d25 commit 8964ebb

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/odoc_for_authors.mld

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,10 +576,12 @@ module M : sig
576576
end
577577
]}
578578

579-
As an exception, [open] statements are allowed to be placed before the top-comment.
579+
As an exception, [open] statements and attributes are allowed to be placed before the top-comment.
580580
For example:
581581

582582
{[
583+
[@@@ocaml.warning "-6"]
584+
583585
(* Copyright header *)
584586

585587
open Base

0 commit comments

Comments
 (0)