Skip to content

Commit 6f6ec5a

Browse files
committed
Fix more instances of present tense in docstrings
1 parent 0b2bb9a commit 6f6ec5a

File tree

16 files changed

+101
-94
lines changed

16 files changed

+101
-94
lines changed

src/appose/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ def custom() -> SimpleBuilder:
389389
def _is_url(source: str) -> bool:
390390
"""
391391
Check if string appears to be a URL.
392-
Detects common URL schemes (http, https, ftp, file, jar) by using
392+
Detect common URL schemes (http, https, ftp, file, jar) by using
393393
a pattern of 3+ letter scheme followed by "://" to avoid matching
394394
Windows drive letters like "C:".
395395

src/appose/builder/__init__.py

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ def base(self, env_dir: str | Path) -> Builder:
217217
@abstractmethod
218218
def channels(self, *channels: str) -> Builder:
219219
"""
220-
Adds channels/repositories to search for packages.
220+
Add channels/repositories to search for packages.
221221
222222
The interpretation of channels is builder-specific:
223223
- Pixi/Mamba: conda channels (e.g., "conda-forge", "bioconda")
@@ -233,7 +233,8 @@ def channels(self, *channels: str) -> Builder:
233233

234234
def file(self, path: str | Path) -> Builder:
235235
"""
236-
Specifies a configuration file to build from.
236+
Specify a configuration file to build from.
237+
237238
Reads the file content immediately and delegates to content().
238239
239240
Args:
@@ -255,7 +256,8 @@ def file(self, path: str | Path) -> Builder:
255256

256257
def url(self, url: str) -> Builder:
257258
"""
258-
Specifies a URL to fetch configuration content from.
259+
Specify a URL to fetch configuration content from.
260+
259261
Reads the URL content immediately and delegates to content().
260262
261263
Args:
@@ -277,7 +279,8 @@ def url(self, url: str) -> Builder:
277279
@abstractmethod
278280
def content(self, content: str) -> Builder:
279281
"""
280-
Specifies configuration file content to build from.
282+
Specify configuration file content to build from.
283+
281284
The scheme will be auto-detected from content syntax.
282285
283286
Args:
@@ -291,7 +294,8 @@ def content(self, content: str) -> Builder:
291294
@abstractmethod
292295
def scheme(self, scheme: str) -> Builder:
293296
"""
294-
Explicitly specifies the scheme for the configuration.
297+
Explicitly specify the scheme for the configuration.
298+
295299
This overrides auto-detection.
296300
297301
Args:
@@ -305,7 +309,7 @@ def scheme(self, scheme: str) -> Builder:
305309
@abstractmethod
306310
def subscribe_progress(self, subscriber: ProgressConsumer) -> Builder:
307311
"""
308-
Registers a callback to be invoked when progress happens during environment building.
312+
Register a callback to be invoked when progress happens during environment building.
309313
310314
Args:
311315
subscriber: Function to call with (title, current, maximum) when progress happens
@@ -318,7 +322,7 @@ def subscribe_progress(self, subscriber: ProgressConsumer) -> Builder:
318322
@abstractmethod
319323
def subscribe_output(self, subscriber: Callable[[str], None]) -> Builder:
320324
"""
321-
Registers a callback to be invoked when output is generated during environment building.
325+
Register a callback to be invoked when output is generated during environment building.
322326
323327
Args:
324328
subscriber: Function to call with output strings
@@ -331,7 +335,7 @@ def subscribe_output(self, subscriber: Callable[[str], None]) -> Builder:
331335
@abstractmethod
332336
def subscribe_error(self, subscriber: Callable[[str], None]) -> Builder:
333337
"""
334-
Registers a callback to be invoked when errors occur during environment building.
338+
Register a callback to be invoked when errors occur during environment building.
335339
336340
Args:
337341
subscriber: Function to call with error strings
@@ -344,7 +348,7 @@ def subscribe_error(self, subscriber: Callable[[str], None]) -> Builder:
344348
@abstractmethod
345349
def flags(self, *flags: str) -> Builder:
346350
"""
347-
Adds command-line flags to be passed to the underlying tool during build operations.
351+
Add command-line flags to be passed to the underlying tool during build operations.
348352
349353
These flags are passed directly to the tool's command-line invocation.
350354
The interpretation of flags is tool-specific:
@@ -418,7 +422,8 @@ def supports_scheme(self, scheme: str) -> bool:
418422
@abstractmethod
419423
def priority(self) -> float:
420424
"""
421-
Returns the priority of this builder for scheme resolution.
425+
Return the priority of this builder for scheme resolution.
426+
422427
Higher priority builders are preferred when multiple builders support the same scheme.
423428
424429
Returns:
@@ -429,7 +434,7 @@ def priority(self) -> float:
429434
@abstractmethod
430435
def can_wrap(self, env_dir: str | Path) -> bool:
431436
"""
432-
Checks if this builder can wrap the given existing environment directory.
437+
Check if this builder can wrap the given existing environment directory.
433438
434439
Args:
435440
env_dir: The directory to check
@@ -612,7 +617,8 @@ def __init__(self):
612617

613618
def bin_paths(self, *paths: str) -> SimpleBuilder:
614619
"""
615-
Appends additional binary paths to search for executables.
620+
Append additional binary paths to search for executables.
621+
616622
Paths are searched in the order they are added.
617623
618624
Args:
@@ -626,7 +632,7 @@ def bin_paths(self, *paths: str) -> SimpleBuilder:
626632

627633
def append_system_path(self) -> SimpleBuilder:
628634
"""
629-
Appends the current process's system PATH directories to the environment's binary paths.
635+
Append the current process's system PATH directories to the environment's binary paths.
630636
631637
Returns:
632638
This builder instance
@@ -637,7 +643,8 @@ def append_system_path(self) -> SimpleBuilder:
637643

638644
def inherit_running_java(self) -> SimpleBuilder:
639645
"""
640-
Configures the environment to use the same Java installation as the parent process.
646+
Configure the environment to use the same Java installation as the parent process.
647+
641648
This prepends ${JAVA_HOME}/bin to the binary paths and sets the JAVA_HOME
642649
environment variable.
643650
@@ -852,7 +859,7 @@ def find_factory_for_wrapping(env_dir: str | Path) -> BuilderFactory | None:
852859

853860
def can_wrap(env_dir: str | Path) -> bool:
854861
"""
855-
Checks if the given directory can be wrapped as a known environment type.
862+
Check if the given directory can be wrapped as a known environment type.
856863
857864
Args:
858865
env_dir: The directory to check
@@ -865,7 +872,7 @@ def can_wrap(env_dir: str | Path) -> bool:
865872

866873
def env_type(env_dir: str | Path) -> str | None:
867874
"""
868-
Returns the environment type name for the given directory.
875+
Return the environment type name for the given directory.
869876
870877
Args:
871878
env_dir: The directory to check

src/appose/builder/mamba.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def env_type(self) -> str:
5353

5454
def build(self) -> Environment:
5555
"""
56-
Builds the Mamba environment.
56+
Build the Mamba environment.
5757
5858
Returns:
5959
The newly constructed Environment
@@ -147,7 +147,7 @@ def build(self) -> Environment:
147147

148148
def wrap(self, env_dir: str | Path) -> Environment:
149149
"""
150-
Wraps an existing Mamba/conda environment directory.
150+
Wrap an existing Mamba/conda environment directory.
151151
152152
Args:
153153
env_dir: The existing environment directory to wrap
@@ -175,7 +175,7 @@ def wrap(self, env_dir: str | Path) -> Environment:
175175

176176
def _create_environment(self, mamba: Mamba, env_dir: Path) -> Environment:
177177
"""
178-
Creates an Environment for the given Mamba/conda directory.
178+
Create an Environment for the given Mamba/conda directory.
179179
180180
Args:
181181
env_dir: The Mamba/conda environment directory
@@ -201,7 +201,7 @@ class MambaBuilderFactory(BuilderFactory):
201201

202202
def create_builder(self) -> Builder:
203203
"""
204-
Creates a new MambaBuilder instance.
204+
Create a new MambaBuilder instance.
205205
206206
Returns:
207207
A new MambaBuilder instance
@@ -213,7 +213,7 @@ def env_type(self) -> str:
213213

214214
def supports_scheme(self, scheme: str) -> bool:
215215
"""
216-
Checks if this builder supports the given scheme.
216+
Check if this builder supports the given scheme.
217217
218218
Args:
219219
scheme: The scheme to check
@@ -225,7 +225,7 @@ def supports_scheme(self, scheme: str) -> bool:
225225

226226
def priority(self) -> float:
227227
"""
228-
Returns the priority for this builder.
228+
Return the priority for this builder.
229229
230230
Returns:
231231
Priority value (higher = more preferred)
@@ -234,7 +234,7 @@ def priority(self) -> float:
234234

235235
def can_wrap(self, env_dir: str | Path) -> bool:
236236
"""
237-
Checks if this builder can wrap the given environment directory.
237+
Check if this builder can wrap the given environment directory.
238238
239239
Args:
240240
env_dir: The directory to check

src/appose/builder/pixi.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def env_type(self) -> str:
5757

5858
def conda(self, *packages: str) -> PixiBuilder:
5959
"""
60-
Adds conda packages to the environment.
60+
Add conda packages to the environment.
6161
6262
Args:
6363
packages: Conda package specifications (e.g., "numpy", "python>=3.8")
@@ -70,7 +70,7 @@ def conda(self, *packages: str) -> PixiBuilder:
7070

7171
def pypi(self, *packages: str) -> PixiBuilder:
7272
"""
73-
Adds PyPI packages to the environment.
73+
Add PyPI packages to the environment.
7474
7575
Args:
7676
packages: PyPI package specifications (e.g., "matplotlib", "requests==2.28.0")
@@ -83,7 +83,7 @@ def pypi(self, *packages: str) -> PixiBuilder:
8383

8484
def build(self) -> Environment:
8585
"""
86-
Builds the Pixi environment.
86+
Build the Pixi environment.
8787
8888
Returns:
8989
The newly constructed Environment
@@ -230,7 +230,7 @@ def build(self) -> Environment:
230230

231231
def wrap(self, env_dir: str | Path) -> Environment:
232232
"""
233-
Wraps an existing Pixi environment directory.
233+
Wrap an existing Pixi environment directory.
234234
235235
Args:
236236
env_dir: The existing environment directory to wrap
@@ -267,7 +267,7 @@ def wrap(self, env_dir: str | Path) -> Environment:
267267

268268
def _create_environment(self, pixi: Pixi, env_dir: Path) -> Environment:
269269
"""
270-
Creates an Environment for the given Pixi directory.
270+
Create an Environment for the given Pixi directory.
271271
272272
Args:
273273
env_dir: The Pixi environment directory
@@ -304,7 +304,7 @@ class PixiBuilderFactory(BuilderFactory):
304304

305305
def create_builder(self) -> Builder:
306306
"""
307-
Creates a new PixiBuilder instance.
307+
Create a new PixiBuilder instance.
308308
309309
Returns:
310310
A new PixiBuilder instance
@@ -316,7 +316,7 @@ def env_type(self) -> str:
316316

317317
def supports_scheme(self, scheme: str) -> bool:
318318
"""
319-
Checks if this builder supports the given scheme.
319+
Check if this builder supports the given scheme.
320320
321321
Args:
322322
scheme: The scheme to check
@@ -328,7 +328,7 @@ def supports_scheme(self, scheme: str) -> bool:
328328

329329
def priority(self) -> float:
330330
"""
331-
Returns the priority for this builder.
331+
Return the priority for this builder.
332332
333333
Returns:
334334
Priority value (higher = more preferred)
@@ -337,7 +337,7 @@ def priority(self) -> float:
337337

338338
def can_wrap(self, env_dir: str | Path) -> bool:
339339
"""
340-
Checks if this builder can wrap the given environment directory.
340+
Check if this builder can wrap the given environment directory.
341341
342342
Args:
343343
env_dir: The directory to check

src/appose/builder/uv.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ def __init__(self):
5656

5757
def python(self, version: str) -> UvBuilder:
5858
"""
59-
Specifies the Python version to use for the virtual environment.
59+
Specify the Python version to use for the virtual environment.
6060
6161
Args:
6262
version: Python version (e.g., "3.11", "3.10")
@@ -69,7 +69,7 @@ def python(self, version: str) -> UvBuilder:
6969

7070
def include(self, *packages: str) -> UvBuilder:
7171
"""
72-
Adds PyPI packages to install in the virtual environment.
72+
Add PyPI packages to install in the virtual environment.
7373
7474
Args:
7575
packages: PyPI package specifications (e.g., "numpy", "requests==2.28.0")
@@ -85,7 +85,7 @@ def env_type(self) -> str:
8585

8686
def build(self) -> Environment:
8787
"""
88-
Builds the uv environment.
88+
Build the uv environment.
8989
9090
Returns:
9191
The newly constructed Environment
@@ -200,7 +200,7 @@ def build(self) -> Environment:
200200

201201
def wrap(self, env_dir: str | Path) -> Environment:
202202
"""
203-
Wraps an existing uv/venv environment directory.
203+
Wrap an existing uv/venv environment directory.
204204
205205
Args:
206206
env_dir: The existing environment directory to wrap
@@ -237,7 +237,7 @@ def wrap(self, env_dir: str | Path) -> Environment:
237237

238238
def _create_environment(self, env_dir: Path) -> Environment:
239239
"""
240-
Creates an Environment for the given uv/venv directory.
240+
Create an Environment for the given uv/venv directory.
241241
242242
Args:
243243
env_dir: The uv/venv environment directory
@@ -272,7 +272,7 @@ class UvBuilderFactory(BuilderFactory):
272272

273273
def create_builder(self) -> Builder:
274274
"""
275-
Creates a new UvBuilder instance.
275+
Create a new UvBuilder instance.
276276
277277
Returns:
278278
A new UvBuilder instance
@@ -284,7 +284,7 @@ def env_type(self) -> str:
284284

285285
def supports_scheme(self, scheme: str) -> bool:
286286
"""
287-
Checks if this builder supports the given scheme.
287+
Check if this builder supports the given scheme.
288288
289289
Args:
290290
scheme: The scheme to check
@@ -296,7 +296,7 @@ def supports_scheme(self, scheme: str) -> bool:
296296

297297
def priority(self) -> float:
298298
"""
299-
Returns the priority for this builder.
299+
Return the priority for this builder.
300300
301301
Returns:
302302
Priority value (higher = more preferred)
@@ -305,7 +305,7 @@ def priority(self) -> float:
305305

306306
def can_wrap(self, env_dir: str | Path) -> bool:
307307
"""
308-
Checks if this builder can wrap the given environment directory.
308+
Check if this builder can wrap the given environment directory.
309309
310310
Args:
311311
env_dir: The directory to check

src/appose/python_worker.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ def __init__(self):
205205

206206
def run(self) -> None:
207207
"""
208-
Processes tasks from the task queue.
208+
Process tasks from the task queue.
209209
"""
210210
self.running = True
211211
Thread(target=self._process_input, name="Appose-Receiver").start()

0 commit comments

Comments
 (0)