RetroAchievements / RAIntegration

The DLL responsible to integrate emulators with RetroAchievements.org
https://retroachievements.org
MIT License
98 stars 23 forks source link

[Suggestion] Remove/Alter Memory Bookmarks "Description Override" feature #1016

Closed cdxemu closed 1 year ago

cdxemu commented 1 year ago

I'd like to get a sense of whether any Devs use the Memory Bookmarks window's feature to override the "Bookmark Description". (We could survey this on Discord as well.)

I personally don't find it useful, but I often find myself mistakenly editing the descriptions while thinking I am editing the Code Notes, only to later find that the Code Notes weren't updated. I've also overheard other Jr Devs mention that they did something similar. Furthermore, the Memory Bookmarks window seems more convenient for editing multiple code notes at once compared to Memory Inspector, as long as they aren't multi-line formatted.

If it's not being used for its intended purpose, I'd suggest removing the feature and have the Memory Bookmarks "Description" field edit the Code Notes instead. On the other hand, if any Devs are using the feature, I'd suggest instead adding highlighting to indicate that text is an override that doesn't match the current Code Note.

redwizard42 commented 1 year ago

I use it sometimes, especially when my note is necessarily long for detail-purposes, but I need something more compact in bookmarks so that I can tell at a glance what it means.

cdxemu commented 1 year ago

I can see that. I'd imagine it's most useful once your code notes are already written/stable. I wouldn't push to remove the feature if it's being used, so I'd suggest the highlighting (bold text?) instead.

The issue I described above mainly happens during memory digging while I am mass-adding memory addresses with blank Code Notes, finding the "correct" one, and then adding its Code Note. That's when I tend to accidentally use the Bookmarks window instead of Inspector.