morgant / mlvwm

Macintosh-like Virtual Window Manager (official repo)
http://www2u.biglobe.ne.jp/~y-miyata/mlvwm.html
275 stars 8 forks source link

'FlashMenu' built-in function is misspelled as 'FlushMenu' in code and documentation #46

Closed morgant closed 3 weeks ago

morgant commented 3 weeks ago

The FlashMenu built-in function was originally and accidentally misspelled as FlushMenu, both in the source code and documentation.

I'd like to correct this by:

  1. Changing the SetMenuFlush() function in mlvwm/config.c to SetMenuFlash()
  2. Updating main_config[] in mlvwm/config.c to: a. Change the FlushMenu entry to map to SetMenuFlash b. Add a corrected FlashMenu entry mapping to the samme SetMenuFlash
  3. Update man/mlvwm.1: a. Change the FlushMenu built-in function name to FlashMenu b. Add a note that the original misspelling of FlashMenu is retained, but depricated

Of course, I'd then like to update the mlvwmrc project's configuration files to s/FlushMenu/FlashMenu/.

morgant commented 3 weeks ago

I have made the 'flush' to 'flash' spelling corrections in code & documentation. I ultimately preserved the entirety of the FlushMenu built-in function implementation, including the separate SetMenuFlush() function in mlvwm/config.c for the sake of simplicity, but updated the manual page to note that FlushMenu is deprecated in favor of FlashMenu.