Skip to content

Commit fbaedc9

Browse files
authored
feat: 📝 Update documentation
1 parent 45c3a76 commit fbaedc9

File tree

5 files changed

+163
-159
lines changed

5 files changed

+163
-159
lines changed

documentation/advanced-usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@ logging.basicConfig(level=logging.DEBUG)
167167
Example:
168168

169169
```
170-
DEBUG:python-injection:`Module(name='default')` now uses `Module(name='my_module')`.
171-
DEBUG:python-injection:`Module(name='default')` has propagated an event: 1 dependency have been updated: `__main__.A`.
170+
DEBUG:python-injection:`Module(name='__default__')` now uses `Module(name='my_module')`.
171+
DEBUG:python-injection:`Module(name='__default__')` has propagated an event: 1 dependency have been updated: `__main__.A`.
172172
DEBUG:python-injection:`Module(name='my_module')` has propagated an event: 1 dependency have been updated: `__main__.B`.
173-
DEBUG:python-injection:`Module(name='default')` has propagated an event: 1 dependency have been updated: `__main__.B`.
173+
DEBUG:python-injection:`Module(name='__default__')` has propagated an event: 1 dependency have been updated: `__main__.B`.
174174
```

documentation/entrypoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Developing a CLI is a good example of using multiple entrypoints:
8585
from injection.entrypoint import autocall
8686
from typer import Typer
8787

88-
from src.entrypoint import entrypoint
88+
from src.entrypoint import entrypoint # the previously defined `entrypoint` decorator
8989
from src.services.logger import AsyncLogger # project service, implementation not provided
9090

9191
app = Typer()

injection/_core/module.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -480,16 +480,15 @@ def decorator(
480480
wrapper = contextmanager(wrapped)
481481

482482
else:
483-
hint = (wrapped,) # type: ignore[assignment]
484483
injectable_class = SimpleScopedInjectable
485-
wrapper = wrapped # type: ignore[assignment]
484+
hint = wrapper = wrapped # type: ignore[assignment]
486485

487486
self.injectable(
488487
wrapper,
489488
cls=partial(injectable_class, scope_name=scope_name),
490489
ignore_type_hint=True,
491490
inject=inject,
492-
on=(*hint, on),
491+
on=(hint, on),
493492
mode=mode,
494493
)
495494
return wrapped

injection/entrypoint.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ def decorator(wp: T) -> T:
4141
return decorator(wrapped) if wrapped else decorator
4242

4343

44+
# SMP = Setup Method Parameters
45+
# EPP = EntryPoint Parameters
46+
47+
4448
@overload
4549
def entrypointmaker[**SMP, **EPP, T1, T2](
4650
wrapped: EntrypointSetupMethod[SMP, EPP, T1, T2],

0 commit comments

Comments
 (0)