search

mattmc3 / antidote

https://getantidote.github.io - the cure to slow zsh plugin management
MIT License
855 stars 21 forks source link

A question with the backquote and apostrophe syntax in antidote-load man page #153

Closed LuckyWindsck closed 10 months ago

LuckyWindsck commented 1 year ago

Hi, I am new to antidote. When I was reading the man page of antidote-load, I found that you are using the backquote and apostrophe format. I am wondering if this is intended or just a typo.

https://github.com/mattmc3/antidote/blob/46d54d4fd7ec44e0d94c985debed582878fafe70/man/man1/antidote-load.1#L37 https://github.com/mattmc3/antidote/blob/46d54d4fd7ec44e0d94c985debed582878fafe70/man/man1/antidote-load.1#L46

If I execute zstyle command in this way, zsh will throw an error: unmatched`.

LuckyWindsck commented 1 year ago

I've just investigate the source code, and only the man page of antidote-load use this syntax.

Screenshot of search result image

However, I found that the man page of antidote-bundle also contains the usage of zstyle command, and it's generated correctly. I am not familiar with pandoc, the software you used to generate man page with markdown file. Should we escape the single quote in markdown file?

Screenshot of search result image
mattmc3 commented 11 months ago

Great question. I pretty much live in the markdown versions of the man pages and let pandoc make the actual man format. Of course, pandoc doesn't perfectly support a conversion from markdown to man, so I think it came out wrong unless I escaped the single ticks, and must've missed some. I'll fix it for 1.9.3. Great catch.

mattmc3 commented 10 months ago

v1.9.3 was released.