lukas.pupkalipinski/Aniworld
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

style: Apply formatter fixes to documentation

Browse Source
This commit is contained in:
Lukas 2025-12-26 12:54:35 +01:00
parent dfdac68ecc
commit 94cf36bff3
3 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/API.md
View File

@ -306,10 +306,10 @@ Add a new series to the library with automatic database persistence, folder crea
**Folder Name Sanitization:** **Folder Name Sanitization:**
- Removes invalid filesystem characters: `< > : " / \ | ? *` - Removes invalid filesystem characters: `< > : " / \ | ? *`
- Trims leading/trailing whitespace and dots - Trims leading/trailing whitespace and dots
- Preserves Unicode characters (for Japanese titles) - Preserves Unicode characters (for Japanese titles)
- Example: `"Attack on Titan: Final Season"` → `"Attack on Titan Final Season"` - Example: `"Attack on Titan: Final Season"` → `"Attack on Titan Final Season"`
Source: [src/server/api/anime.py](../src/server/api/anime.py#L604-L710) Source: [src/server/api/anime.py](../src/server/api/anime.py#L604-L710)

12
docs/ARCHITECTURE.md
View File

@ -123,12 +123,12 @@ src/core/
**Key Components:** **Key Components:**
| Component | Purpose | | Component | Purpose |
| ----------------- | ----------------------------------------------------------------------- | | -------------- | -------------------------------------------------------------------------- |
| `SeriesApp` | Main application facade for anime operations | | `SeriesApp` | Main application facade for anime operations |
| `SerieScanner` | Scans directories for anime; `scan_single_series()` for targeted scans | | `SerieScanner` | Scans directories for anime; `scan_single_series()` for targeted scans |
| `Serie` | Domain entity with `sanitized_folder` property for filesystem-safe names | | `Serie` | Domain entity with `sanitized_folder` property for filesystem-safe names |
| `SerieList` | Collection management with automatic folder creation using sanitized names | | `SerieList` | Collection management with automatic folder creation using sanitized names |
Source: [src/core/](../src/core/) Source: [src/core/](../src/core/)

20
docs/instructions.md
View File

@ -208,17 +208,19 @@ Enhance the anime addition workflow to automatically persist anime to the databa
### Implementation Summary (Completed) ### Implementation Summary (Completed)
**Files Created/Modified:** **Files Created/Modified:**
- `src/server/utils/filesystem.py` - New file with `sanitize_folder_name()`, `is_safe_path()`, `create_safe_folder()`
- `src/core/entities/series.py` - Added `sanitized_folder` property - `src/server/utils/filesystem.py` - New file with `sanitize_folder_name()`, `is_safe_path()`, `create_safe_folder()`
- `src/core/entities/SerieList.py` - Updated `add()` to use sanitized folder names - `src/core/entities/series.py` - Added `sanitized_folder` property
- `src/core/SerieScanner.py` - Added `scan_single_series()` method - `src/core/entities/SerieList.py` - Updated `add()` to use sanitized folder names
- `src/server/api/anime.py` - Enhanced `add_series` endpoint with full flow - `src/core/SerieScanner.py` - Added `scan_single_series()` method
- `src/server/api/anime.py` - Enhanced `add_series` endpoint with full flow
**Tests Added:** **Tests Added:**
- `tests/unit/test_filesystem_utils.py` - 43 tests for filesystem utilities
- `tests/unit/test_serie_class.py` - 6 tests for `sanitized_folder` property - `tests/unit/test_filesystem_utils.py` - 43 tests for filesystem utilities
- `tests/unit/test_serie_scanner.py` - 9 tests for `scan_single_series()` - `tests/unit/test_serie_class.py` - 6 tests for `sanitized_folder` property
- `tests/api/test_anime_endpoints.py` - 6 integration tests for enhanced add flow - `tests/unit/test_serie_scanner.py` - 9 tests for `scan_single_series()`
- `tests/api/test_anime_endpoints.py` - 6 integration tests for enhanced add flow
**All 97 related tests passing. No regressions in existing 848 unit tests and 60 API tests.** **All 97 related tests passing. No regressions in existing 848 unit tests and 60 API tests.**