gavindiaz/wickra
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

E14: remove hardcoded local paths from the docs

Browse Source 
Indicators-Overview.md referenced the absolute author-machine paths
D:\Coding\Wickra\crates\... and D:\Coding\Wickra\bindings\... in its
"Source-of-truth files" section, and seven trend-indicator pages had
Node examples that did require('D:/Coding/Wickra/bindings/node').

Replace the overview paths with repo-relative GitHub links and change
the Node examples to require('wickra'), the published npm package name
a reader would actually use. No D:/Coding path remains anywhere in docs.
This commit is contained in:
kingchenc
2026-05-22 16:18:48 +02:00
parent 278b6afaa4
commit b3ddbea584
8 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/wiki/Indicators-Overview.md
+7 -6
View File
@@ -179,12 +179,13 @@ what each indicator actually computes.
## Source-of-truth files
Every claim above can be checked against the source in
`D:\Coding\Wickra\crates\wickra-core\src\indicators\` — one file per
indicator. The Rust unit tests inside each module are the ground truth
for sample values. Python defaults (the `period = 14` etc. in tables
above) come from the `#[pyo3(signature = …)]` attributes in
`D:\Coding\Wickra\bindings\python\src\lib.rs`; indicators not listed
with a Python default require an explicit `period` argument.
[`crates/wickra-core/src/indicators/`](https://github.com/kingchenc/wickra/tree/main/crates/wickra-core/src/indicators)
— one file per indicator. The Rust unit tests inside each module are the
ground truth for sample values. Python defaults (the `period = 14` etc. in
tables above) come from the `#[pyo3(signature = …)]` attributes in
[`bindings/python/src/lib.rs`](https://github.com/kingchenc/wickra/blob/main/bindings/python/src/lib.rs);
indicators not listed with a Python default require an explicit `period`
argument.
## See also