Skip to content

Commit 21ffae9

Browse files
committed
Use imperative tense for function docstrings
1 parent 0778a89 commit 21ffae9

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

src/scyjava/_introspect.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def jreflect(data, aspect: str) -> List[Dict[str, Any]]:
6161

6262
def _map_syntax(base_type):
6363
"""
64-
Maps a Java BaseType annotation (see link below) in an Java array
64+
Map a Java BaseType annotation (see link below) in an Java array
6565
to a specific type with an Python interpretable syntax.
6666
https://docs.oracle.com/javase/specs/jvms/se7/html/jvms-4.html#jvms-4.3
6767
"""
@@ -88,7 +88,7 @@ def _map_syntax(base_type):
8888

8989
def _make_pretty_string(entry, offset):
9090
"""
91-
Prints the entry with a specific formatting and aligned style
91+
Print the entry with a specific formatting and aligned style.
9292
:param entry: Dictionary of class names, modifiers, arguments, and return values.
9393
:param offset: Offset between the return value and the method.
9494
"""
@@ -113,7 +113,7 @@ def _make_pretty_string(entry, offset):
113113

114114
def java_source(data):
115115
"""
116-
Tries to find the source code using Scijava's SourceFinder
116+
Try to find the source code using SciJava's SourceFinder.
117117
:param data: The object or class or fully qualified class name to check for source code.
118118
:return: The URL of the java class
119119
"""
@@ -145,7 +145,8 @@ def java_source(data):
145145

146146
def _print_data(data, aspect, static: Optional[bool] = None, source: bool = True):
147147
"""
148-
Writes data to a printed string of class methods with inputs, static modifier, arguments, and return values.
148+
Write data to a printed string of class methods with inputs, static modifier,
149+
arguments, and return values.
149150
150151
:param data: The object or class to inspect or fully qualified class name.
151152
:param aspect: Whether to print class 'fields' or 'methods'.
@@ -195,7 +196,7 @@ def _print_data(data, aspect, static: Optional[bool] = None, source: bool = True
195196

196197
def src(data):
197198
"""
198-
Prints the source code URL for a Java class, object, or class name.
199+
Print the source code URL for a Java class, object, or class name.
199200
200201
:param data: The Java class, object, or fully qualified class name as string
201202
"""

0 commit comments

Comments
 (0)