uFuzzy
uFuzzy copied to clipboard
Update documentation on intraRules, search example
Updated the docs on the few things I struggled a bit with:
- Search was missing an example, beyond the time figuring it out, I ended up having to step through the code in-depth to understand why the order was null when using outOfOrder
-
intraRules
wasn't documented, so I added it based on #53 - The section on
intraSub
,intraTrn
, andintraDel
, I kept finding myself having to re-search through the docs to remember what they meant, as it only said in theintraMode: 1
section.
For the search example, I didn't include it in the doc but I did test it out via Codepen: https://codepen.io/ascendedguard/pen/PoLZdBJ
thanks!
i actually want to encourage people to use the integrated search, so feel like it should be listed first, but struggle with how to explain the concepts of idxs
, info
, order
. :thinking:
Added some more detail to explain it some more, let me know what you think.
Forgot to mention it originally, but I left the variable declarations as let
to match the rest of your docs, although they could have all been const
instead. They're const
in the Codepen.
Anything you need to be able to close this out?