openstenoproject / plover

Open source stenotype engine
http://opensteno.org/plover
GNU General Public License v2.0
2.36k stars 277 forks source link

Tooltip format is inconsistent #963

Open nsmarkop opened 6 years ago

nsmarkop commented 6 years ago

Summary

Tooltips in Plover don't seem to agree on if they should end with a period or not.

For example, the buttons to move dictionaries up and down end with periods:

image

But the ones for editing / deleting / adding dictionaries don't:

image

Most of the places I've checked end with periods.

Tool plugins are a place outside of core Plover code that also have inconsistencies since they have tooltips constructed from the class documentation which may or may not have a period depending on the developer. I'm not sure if it's a good thing to try and check then force one for those specific use cases, though.

Reproducing

Open Plover and mouse over some stuff like the buttons mentioned in the problem summary.

Plover Version

Plover 4.0.0.dev8

System

Windows 10

SeaLiteral commented 6 years ago

This can also be reproduced on Linux, and I guess it should also apply on Mac. This should be as easy as scanning for .', ." and .< and manually checking which ones are tooltips, then removing the periods where appropriate. Another option could be adding periods to those tooltips that don't have it, but most other software I use tends to not have them, so I think removing them would be the best option. Interestingly, individual files seem to mostly be consistent with themselves, whereas some files use periods and others don't. A PR fixing this should be out shortly.

SeaLiteral commented 6 years ago

I'll have to make actual code changes, not just string changes. Some of the strings used as tooltips are fetched in a slightly problematic way:

if tool.__doc__ is not None:
    action.setToolTip(tool.__doc__)

That won't show up in the pot file, and thus it will show in English even if you set plover to show everything else in another language.