-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add fsrs version to debug info #17304
Add fsrs version to debug info #17304
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The FSRS version is technically correct (in that it's the library version) but not what we should display to the user.
A user would expect this version to be "FSRS 4.5", and not displaying this will lead to confusion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Requested change:
I feel hardcoding a mapping from 'internal' to 'user-facing' version is the most effective way to quickly solve this
- Hardcode a mapping from
0.6.4
to4.5
- Add a unit test which will break if the
BuildConfig
changes from0.6.4
- In a future version, we expect to move this to the backend
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- capitalization nits
AnkiDroid/src/main/java/com/ichi2/anki/preferences/AboutFragment.kt
Outdated
Show resolved
Hide resolved
29ac8da
to
0d716ec
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cheers!
Once this is merged, we should add an issue to expose this version in the backend
That will remove the need to perform additional code changes when bumping the backend version
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With apologies for the back & forth. After a discussion with Voczi, Jarrett Ye & Expertium, there's consensus for displaying the library version.
Voczi
user facing version covers a larger amount of changes in fsrs at a time, library version covers smaller amount of changes at a time. thats how i understood it
Expertium
[FSRS library version], since it's more informative
There are minor changes within major FSRS versions
Jarrett
I prefer lib version
https://github.com/open-spaced-repetition/fsrs-rs/releases
You can see all changes introduced by any version.
https://discord.com/channels/368267295601983490/701922522836369498/1298985695645270097
I personally disagree here (I believe displaying the user-facing version is better), but it's a quick change to make to improve things if necessary
The FSRS devs will feel the support burden from this change more than AnkiDroid, and it's only fair to them to help them with user support as much as possible
0d716ec
to
e9efd84
Compare
I've reverted the changes to the initial state, this includes showing only the library version in the debug info.
I also think the user facing version is better. Looking through discussions on ankiweb's forums the users refer to FSRS in terms of 4.5, 5 and not library version which is mostly a dev thing. Even if there are issues with FSRS, we ask for debug info which would include the precise library version anyway. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm also going with it as the stated preference of the devs following my general "implementor's choice" rule, which is even stronger if it's "people doing support's choice". We can add a mapping later if we really need it
Purpose / Description
Adds the fsrs version to the debug info. In a separate commit I also added the version to the about settings screen so it can be removed if not wanted(or maybe combine the backend and fsrs info):
Fixes
Towards #17236
How Has This Been Tested?
Looked at the debug info, looked at the settings screen
Checklist