mirror of
https://github.com/mihakralj/QuanTAlib.git
synced 2026-08-25 13:58:04 +00:00
Refactor documentation to remove "Zero-Allocation Design" sections across various trend indicators and implement a PowerShell script for automated cleanup
- Updated mathematical foundations and performance profiles where necessary to maintain clarity and coherence.
This commit is contained in:
@@ -187,6 +187,7 @@ public TValue Update(TValue input, bool isNew = true)
|
||||
* **Format**: Markdown.
|
||||
* **Content**: Title, Description, Parameters, Formula (LaTeX), C# Usage Examples.
|
||||
* **Style**: Follow the guidelines in `.clinerules/techdocs.md` (Bryson-Executive voice, architectural focus, evidence-based).
|
||||
* **Pronouns**: Avoid first-person plural in documentation; prefer explicit "QuanTAlib" subject or passive voice. Treat this as a persistent style rule (to be stored in qdrant style/pattern entries when available).
|
||||
* **Index & Links**: Add the new indicator to:
|
||||
* Category index (e.g., `lib/trends/_index.md`)
|
||||
* Main library index (`lib/_index.md`)
|
||||
@@ -245,3 +246,4 @@ When creating a new indicator, you are **DONE** only when:
|
||||
* **Time**: Use `DateTime.UtcNow`.
|
||||
* **Math**: Use `System.Math` or `System.Numerics`.
|
||||
* **Root Namespace**: `QuanTAlib`.
|
||||
* **Patterns & Decisions**: When designing, refactoring, or fixing indicators or tests, first query `qdrant.mcp` for stored QuanTAlib patterns, architectural decisions, and benchmarks, and align new work with those references unless there is a documented reason to diverge.
|
||||
|
||||
@@ -24,6 +24,7 @@ LANGUAGE PRINCIPLES & SLAVIC CADENCE
|
||||
Efficiency: Use a direct, slightly article-omitting cadence (e.g., "Architecture is trade-off. You want speed? Give me memory.").
|
||||
Grizzled Verbs: Code doesn't "run"; it grinds, chokes, strains, or sprints.
|
||||
Precision: Use exact numbers ("3.2ms latency") and specific comparisons ("40% faster than TA-Lib").
|
||||
No First-Person Plural: Documentation avoids "we"; prefer explicit "QuanTAlib" subject or passive constructions. Treat this as a persistent style rule suitable for qdrant style/pattern entries.
|
||||
Sentence Architecture: Vary length deliberately. Short declarative → Medium elaboration → Short, punchy conclusion.
|
||||
|
||||
HUMOR: THE COGNITIVE HOMEOSTATIC MECHANISM
|
||||
|
||||
Reference in New Issue
Block a user