FIX Fix a bug that comment of the arrow function in the interface is not rendered (#284)

* Fix bug that comment of arrow function in the interface is not preserved

* Update sphinx_js/js/convertTopLevel.ts

Co-authored-by: Hood Chatham <[email protected]>

* changelog

---------

Co-authored-by: Hood Chatham <[email protected]>

Author: ryanking13

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+### 5.0.1: (September 17th, 2025)
+- Fixed a bug that comment of the arrow function in the interface is not rendered correctly.
+  (pyodide/sphinx-js#284)
+
 ### 5.0.0: (July 2nd, 2025)
 
 - Dropped support for Python 3.9 (pyodide/sphinx-js-fork#7)

sphinx_js/js/convertTopLevel.ts

@@ -537,7 +537,15 @@ export class Converter {
       // Render {f: () => void} like {f(): void}
       // TODO: unclear if this is the right behavior. Maybe there should be a
       // way to pick?
-      return [this.functionToIR(prop.type.declaration), []];
+      const functionIR = this.functionToIR(prop.type.declaration);
+
+      // Preserve the property's own documentation if it exists
+      functionIR.description = renderCommentSummary(prop.comment);
+
+      // Preserve the optional flag from the original property
+      functionIR.is_optional = prop.flags.isOptional;
+
+      return [functionIR, []];
     }
     let type: Type;
     if (prop.comment?.modifierTags.has("@hidetype")) {

tests/test_build_ts/source/class.ts

@@ -43,8 +43,18 @@ export class ExportedClass {
 export class ConstructorlessClass {}
 
 export interface OptionalThings {
+  /**
+   * foop should preserve this documentation
+   */
   foop?(): void;
+  /**
+   * boop should preserve this documentation
+   */
   boop?: boolean;
+  /**
+   * noop should preserve this documentation
+   */
+  noop?: () => void;
 }
 
 /**

tests/test_build_ts/test_build_ts.py

@@ -98,7 +98,15 @@ def test_optional_members(self):
             "\n"
             "      type: boolean\n"
             "\n"
-            "   OptionalThings.foop?()\n",
+            "      boop should preserve this documentation\n"
+            "\n"
+            "   OptionalThings.foop?()\n"
+            "\n"
+            "      foop should preserve this documentation\n"
+            "\n"
+            "   OptionalThings.noop?()\n"
+            "\n"
+            "      noop should preserve this documentation\n",
         )
 
     def test_deprecated(self):