Skip to content

Commit 481d04a

Browse files
docs: improve formatting and clarity in concepts and installation documentation
1 parent c054701 commit 481d04a

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

docs/concepts.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,7 @@ This means:
352352
```python
353353
from archipy.helpers.decorators.sqlalchemy_atomic import postgres_sqlalchemy_atomic_decorator
354354

355+
355356
class UserRegistrationLogic:
356357
@postgres_sqlalchemy_atomic_decorator
357358
def register_user(self, input_dto: UserRegistrationInputDTO) -> UserRegistrationOutputDTO:
@@ -374,6 +375,7 @@ class AppConfig(BaseConfig):
374375
"""Application-specific configuration. Add custom fields here."""
375376
...
376377

378+
377379
config = AppConfig()
378380
BaseConfig.set_global(config)
379381
```

docs/installation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Before starting, ensure you have:
1313

1414
Check your version with:
1515

16-
```bash
17-
python --version
18-
```
16+
```bash
17+
python --version
18+
```
1919

2020
If needed, [download Python 3.14+](https://www.python.org/downloads/).
2121

@@ -25,7 +25,7 @@ Before starting, ensure you have:
2525
the [official guide](https://docs.astral.sh/uv/getting-started/installation/).
2626

2727
!!! tip "Recommended Package Manager"
28-
ArchiPy recommends **`uv`** — it is significantly faster than `pip` and provides better dependency resolution.
28+
ArchiPy recommends **`uv`** — it is significantly faster than `pip` and provides better dependency resolution.
2929

3030
## Install ArchiPy
3131

@@ -101,9 +101,9 @@ If issues arise, verify:
101101
4. Database-specific dependencies are installed if using database adapters
102102

103103
!!! tip "IDE Integration"
104-
For the best development experience, use an IDE that supports Python type hints, such as PyCharm or VS Code with the
105-
Python extension. The project uses modern Python type hints and benefits from IDE support for type checking and
106-
autocompletion.
104+
For the best development experience, use an IDE that supports Python type hints, such as PyCharm or VS Code with the
105+
Python extension. The project uses modern Python type hints and benefits from IDE support for type checking and
106+
autocompletion.
107107

108108
## See Also
109109

0 commit comments

Comments
 (0)