Skip to content

Commit e49f3ce

Browse files
gselzerclaude
andcommitted
code-lsp-jython: describe JavaStubs anew
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 7e93620 commit e49f3ce

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

  • scijava-code-lsp-jython/src/main/java/org/scijava/code/lsp/jython

‎scijava-code-lsp-jython/src/main/java/org/scijava/code/lsp/jython/JavaStubs.java‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,12 @@
6464
/**
6565
* Writes Python type stubs ({@code .pyi}) of Java packages, so that a Python
6666
* language server (e.g. jedi-language-server) knows the Java classes a Jython
67-
* script uses: {@code from ij import IJ} then finds {@code ij/__init__.pyi},
68-
* with {@code IJ}'s methods, their parameters and return types.
67+
* script uses.
68+
* <p>
69+
* For example, for {@code from ij import IJ}, the server finds
70+
* {@code ij/__init__.pyi}, with {@code IJ}'s methods, their parameters and
71+
* return types.
72+
* </p>
6973
* <p>
7074
* Stubs are written on demand, per package, from the classes themselves (as
7175
* the given class loader loads them), in the background; and so are the
@@ -75,6 +79,10 @@
7579
* {@code typing.overload}s; getters become properties too, as Jython offers
7680
* them.
7781
* </p>
82+
* <p>
83+
* TODO: Consider scyjava's stubs instead (see
84+
* <a href="https://github.com/scijava/scyjava/pull/86">scyjava.types</a>).
85+
* </p>
7886
*
7987
* @author Gabriel Selzer
8088
*/

0 commit comments

Comments
 (0)