uFuzzy icon indicating copy to clipboard operation
uFuzzy copied to clipboard

Update documentation on intraRules, search example

Open ascendedguard opened this issue 1 year ago • 3 comments

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, and intraDel, I kept finding myself having to re-search through the docs to remember what they meant, as it only said in the intraMode: 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

ascendedguard avatar Jan 04 '24 22:01 ascendedguard

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:

leeoniya avatar Jan 04 '24 23:01 leeoniya

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.

ascendedguard avatar Jan 05 '24 02:01 ascendedguard

Anything you need to be able to close this out?

ascendedguard avatar Apr 03 '24 13:04 ascendedguard