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

Top comments in modules and attributes #1101

Open
jonludlam opened this issue Mar 28, 2024 · 0 comments
Open

Top comments in modules and attributes #1101

jonludlam opened this issue Mar 28, 2024 · 0 comments

Comments

@jonludlam
Copy link
Member

While changing the positioning of the deprecated attribute according to ocaml/ocaml#13054, the HTML output changed, removing the 'Top Comment' that was being output into Alert.html. There are some changes to the other HTML files too, but this was the one that looked suspicious.

Diffs look like:

--- a/test/generators/cases/alerts.mli
+++ b/test/generators/cases/alerts.mli
@@ -17,13 +17,11 @@ val c : int
 (* At the top-level of a module. *)

 module Top1 : sig
-  [@@@deprecated "A"]

   (** Top-comment. *)
-end
+end[@@deprecated "A"]

-module Top2 : sig
-  [@@@deprecated "A"]
+module[@deprecated "A"] Top2 : sig

   (** Top-comment. *)
 end

and

--- a/test/generators/html/Alerts.html
+++ b/test/generators/html/Alerts.html
@@ -57,7 +57,7 @@
        <span class="keyword">end</span>
       </span>
      </code>
-    </div><div class="spec-doc"><p>Top-comment.</p></div>
+    </div>
    </div>
    <div class="odoc-spec">
     <div class="spec module anchored" id="module-Top2">
@@ -70,7 +70,7 @@
        <span class="keyword">end</span>
       </span>
      </code>
-    </div><div class="spec-doc"><p>Top-comment.</p></div>
+    </div>
    </div>
    <div class="odoc-spec">
     <div class="spec value anchored" id="val-d">
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant