open-spaced-repetition / rs-fsrs

Rust-based Scheduler for FSRS
https://crates.io/crates/rs-fsrs
MIT License
24 stars 6 forks source link

Where's the Docs? #11

Closed DrAlta closed 7 months ago

DrAlta commented 12 months ago

How does one use this? There is no documentation and no comments. I tried looking at the other implementation of FSRS but they are all in the same state.

L-M-Sherlock commented 7 months ago

The ts-fsrs package has a detailed documentation: https://github.com/open-spaced-repetition/ts-fsrs?tab=readme-ov-file#basic-use

DrAlta commented 7 months ago

3. Scheduling with FSRS:
The core functionality lies in the fsrs function. When invoked, it returns a collection of cards scheduled based on different potential user ratings:```

code uses the `FSRS()` function instead of `fsrs()`
L-M-Sherlock commented 7 months ago

Because ts-fsrs has fsrs function:

export const fsrs = (params?: Partial<FSRSParameters>) => {
  return new FSRS(params || {});
};

https://github.com/open-spaced-repetition/ts-fsrs/blob/55b0a1eb8e95b3df1995bb97b3796b030abfb850/src/fsrs/fsrs.ts#L430-L432