mirror of
https://github.com/NicolasBohn/NexQuant.git
synced 2026-08-09 13:00:56 +00:00
docs: Translate all code comments to English
- Updated QWEN.md with English-only comment policy - Translated all German comments in: * eurusd_regime.py * eurusd_llm.py * eurusd_reflection.py * eurusd_memory.py * eurusd_macro.py * eurusd_debate.py * predix_dashboard.py - All comments, docstrings, and print statements now in English - Ensures consistency with commit messages and documentation Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
This commit is contained in:
@@ -151,7 +151,39 @@ pre-commit run --all-files
|
||||
|
||||
## Development Conventions
|
||||
|
||||
### Language Policy
|
||||
|
||||
**ALL code comments and documentation MUST be in English.**
|
||||
|
||||
❌ **Wrong (German):**
|
||||
```python
|
||||
# Inspiriert von: TradingAgents
|
||||
# Berechnet den Sharpe Ratio
|
||||
# Achtung: Division durch Null möglich!
|
||||
# Hinweis: Diese Funktion ist experimentell
|
||||
```
|
||||
|
||||
✅ **Correct (English):**
|
||||
```python
|
||||
# Inspired by: TradingAgents
|
||||
# Calculates the Sharpe ratio
|
||||
# Warning: Division by zero possible!
|
||||
# Note: This function is experimental
|
||||
```
|
||||
|
||||
**Rationale:**
|
||||
- International collaboration
|
||||
- Better searchability
|
||||
- Professional codebase
|
||||
- Consistent with commit messages (also English-only)
|
||||
|
||||
**Enforcement:**
|
||||
- All new code must have English comments
|
||||
- Existing German comments should be translated when modified
|
||||
- PRs with German comments will be rejected
|
||||
|
||||
### Code Style
|
||||
|
||||
- **Line length:** 120 characters (configured in pyproject.toml)
|
||||
- **Type hints:** Required for all public functions
|
||||
- **Docstrings:** Google style for public APIs
|
||||
|
||||
Reference in New Issue
Block a user