search

StyleGuides / WritingStyleGuide

The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Creative Commons Attribution Share Alike 4.0 International
71 stars 19 forks source link

Tab characters example reads as a title instead of a directive #584

Open jdandrea opened 4 days ago

jdandrea commented 4 days ago

https://github.com/StyleGuides/WritingStyleGuide/blob/1604485f16a472b329a43551ba561ecd8b7416c4/en-US/Language.xml#L1242

Suggestion: Replace "How to show or hide tab characters." with "To show or hide tab characters in Vim, use the /\t and noh commands." Note that this is a contrived example.