openSUSE/suse-doc-style-checker

correction of "staring with" is problematic...

Opened this issue · 0 comments

typos.xslc corrects "staring with"->"starting with", while that is usually correct in our documentation, it is easy to find example sentence where this correction is inappropriate: "Staring with both my eyes open, I went."

maybe there is a better way of detecting "staring" being misused?

  • we often have version numbers: "Starting with (the)? Linux kernel (version)? 2.6"
  • some kind of start string wrapped in literal: "IP addresses starting with 192.168.1." / "Lines starting with #"
  • start strings wrapped in quotes: " starting with '/' "

additionally, maybe we could also flag "star_ a program" or so.