gist icon indicating copy to clipboard operation
gist copied to clipboard

docs: remove unicode zero length characters and fix Markdown to man page conversion

Open lucasrangit opened this issue 5 years ago • 6 comments

Fix the typo from #325 and remove Unicode zero width characters from Markdown. Also format some vars with backticks.

Rendering of the README.md on github.com has not changed without the Unicode characters.

lucasrangit avatar Sep 15 '20 13:09 lucasrangit

@lucasrangit I think these zero-width characters are used in the production of the man page, though it's been a long time since I looked into it, does that still work correctly without them?

ConradIrwin avatar Sep 15 '20 16:09 ConradIrwin

Oh! :open_mouth: I'll check.

lucasrangit avatar Sep 16 '20 14:09 lucasrangit

@lucasrangit I think these zero-width characters are used in the production of the man page, though it's been a long time since I looked into it, does that still work correctly without them?

You were absolutely right. The man page came out fine without the asterisks. But to be consistent, I replaced the Unicode with asterisks since there were getting substituted in the Rakefile anyway and the Markdown looks the same on GitHub. I think the Unicode make it harder to edit.

I also noticed a few other Markdown to man page issues and fixed them.

lucasrangit avatar Sep 16 '20 14:09 lucasrangit

cc @ConradIrwin

bl-ue avatar Apr 02 '21 11:04 bl-ue

Thanks for the review @bl-ue . Just curious, does this PR address any issues with tldr?

lucasrangit avatar Apr 04 '21 19:04 lucasrangit

Sharp eye you have there, @lucasrangit! 😎

As it happens, this PR doesn't fix anything with tldr. I started browsing this repo because I was reviewing a pull request of @nicokosi's (https://github.com/tldr-pages/tldr/pull/5666), and then I came upon this PR. Seeing some uncertainty as to the benefit of this PR (which, by the way, is great and definitely needed), I thought I'd add my +1.

In fact, you can even see "<200c>For Ubuntu/Debian" right on the readme 😝

However, you're more than most welcome to contribute in any way to the tldr-pages project, if you feel inclined to do so!!

bl-ue avatar Apr 04 '21 20:04 bl-ue