Skip to content

Commit 313dedd

Browse files
committed
Improve some docstrings
1 parent 030f91a commit 313dedd

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

src/scyjava/_convert.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def _convertIterable(obj: collections.abc.Iterable):
7979

8080
def add_java_converter(converter: Converter):
8181
"""
82-
Adds a converter to the list used by to_java
82+
Add a converter to the list used by to_java.
8383
:param converter: A Converter going from python to java
8484
"""
8585
java_converters.append(converter)
@@ -108,10 +108,10 @@ def to_java(obj: Any) -> Any:
108108

109109
def _stock_java_converters() -> List[Converter]:
110110
"""
111-
Returns all python-to-java converters supported out of the box!
112-
This should only be called after the JVM has been started!
111+
Construct the Python-to-Java converters supported out of the box.
113112
:returns: A list of Converters
114113
"""
114+
start_jvm()
115115
return [
116116
# Other (Exceptional) converter
117117
Converter(
@@ -390,7 +390,7 @@ def __str__(self):
390390

391391
def add_py_converter(converter: Converter):
392392
"""
393-
Adds a converter to the list used by to_python
393+
Add a converter to the list used by to_python.
394394
:param converter: A Converter from java to python
395395
"""
396396
py_converters.append(converter)
@@ -430,10 +430,10 @@ def to_python(data: Any, gentle: bool = False) -> Any:
430430

431431
def _stock_py_converters() -> List:
432432
"""
433-
Returns all java-to-python converters supported out of the box!
434-
This should only be called after the JVM has been started!
433+
Construct the Java-to-Python converters supported out of the box.
435434
:returns: A list of Converters
436435
"""
436+
start_jvm()
437437

438438
converters = [
439439
# Other (Exceptional) converter

0 commit comments

Comments
 (0)