search

krisk / Fuse

Lightweight fuzzy-search, in JavaScript
https://fusejs.io/
Apache License 2.0
18.05k stars 766 forks source link

Fix problems in readme #477

Closed joyously closed 3 years ago

joyously commented 4 years ago

Description

The readme refers to pages that don't exist and the example code is misleading.

Describe the solution you'd like

The line of code fuse.search('jon') should be more like it is actually used, assigning to a variable, and then instead of a comment stating "Output:" (which is not really output), it could say that the variable contains that. The links that don't work are the stories and the demo, near the bottom of the readme.

Edit: Looking at this again, because I tried to link to the file, but GitHub was not cooperating because it is a readme. I'm referring to docs/README.md, which shows when you are browsing the repo. Apparently, the links are okay when viewed on fusejs.io, but for those of us trying to figure out how to use this thing, it comes down to browsing around, so the links are broken from there... I was going to open different issues for the docs listed under API Reference, but I can simply mention here that they are too sparse and don't show the function signatures. Also, the fusejs.io pages themselves have serious problems with scrolling to the correct place when clicking a link, as if it is relative to where you were instead of where it's going.

github-actions[bot] commented 3 years ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days