Bug 461295 - Matching example is incorrect
Summary: Matching example is incorrect
Status: RESOLVED FIXED
Alias: None
Product: kmymoney
Classification: Applications
Component: documentation (show other bugs)
Version: 5.1.3
Platform: Other Linux
: NOR normal
Target Milestone: ---
Assignee: Jack
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-11-01 19:15 UTC by jesse
Modified: 2022-11-13 23:01 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In: 5.1.4
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description jesse 2022-11-01 19:15:55 UTC
SUMMARY
The example on this page: https://docs.kde.org/stable5/en/kmymoney/kmymoney/details.payees.personalinformation.html#details.payees.personalinformation.matching
is incorrect. The image shows the matching name as sun trust and the text explains that the application will be able to match the transactions with SUNTRUST in the name to the payee. 

STEPS TO REPRODUCE
1. go to https://docs.kde.org/stable5/en/kmymoney/kmymoney/details.payees.personalinformation.html#details.payees.personalinformation.matching
2. Read the example and compare to the image


OBSERVED RESULT
The example says that the application will be able to match “SUNTRUST BANK MAPLE VALLEY, GA 111506” and “SUNTRUST BANK MAPLE VALLEY, GA 121606”  using the matching value of 'sun trust'. 

EXPECTED RESULT
the matching value will need to be SUNTRUST in the image. 

SOFTWARE/OS VERSIONS
Linux/KDE Plasma: Fedora Gnome 36 
KDE Plasma Version: n/a
KDE Frameworks Version:KDE Frameworks 
Version 5.98.0 
Qt Version: Qt 
Version 5.15.5 (built against 5.15.5)
ADDITIONAL INFORMATION
 
App image: KMyMoney
Version 5.1.3-3408d1edc
Comment 1 Dawid Wróbel 2022-11-02 14:24:04 UTC
Assigning this to Jack since he's the documentation guru.
Comment 2 Jack 2022-11-10 01:49:31 UTC
Sorry for the delay.  I'll update that page, but it's not as simple as it seems.  I see the screenshot showing the state of that page before adding "suntrust" to the list.  The existing "sun trust" is the starting point of just matching the payee name exactly (although I would expect it to be "Sun Trust" to match the actual name, even though case is ignored.)  I'll have to confirm the actual default settings on this page, and mention that in the updated text.
Comment 3 Jack 2022-11-13 23:00:43 UTC
Since it is far easier to change the text than the screenshot, I simply changed all the examples from using SUNTRUST to SUN TRUST (adding the space.)  (I've pushed to both 5.1 and master.)  In the future, it might be worth also adding SUNTRUST (without the space) showing how to match with or without the space - but I wouldn't do that without updating the screenshot.
Comment 4 Jack 2022-11-13 23:01:43 UTC
(I forgot to include the bug reference in the commit, so I manually added the 5.1 commit hash above.)