Improve comment markdown style by making it look pretty

[kutsan]

Problem

My feature request about the markdown style this bot uses in its comments. As you can see the picture, it's bulky and crowded. It doesn't provide a clean solution to the problem we have. It should be clean and informative, not spammy and try-to-be-interactive. There are unnecessary bits and things we can improve. So, I believe we can make it look better.

1. There is no need for please contact section since it's a open-source project and most of the vim users are programmers I think you should not ask people send messages about the bugs they found rather you can ask them to create issues in GitHub which is better to keep track of and make your inbox clean.
2. Source code link is a must. People need to know this is an open-source project and PRs are welcome at the first glance.
3. There is no how to use snippet. It's a super-simple bot and you're making them to go bot's reddit profile and read the description.
4. Here are all the tags that matched is madness. You're simply posting spam at that point. As you can see in this comment there is no need to show all the tags that bot have matched. It's enough to post the best match. Even, it's enough to simply ignore it if it's not the exact match. This is not an interactive interface and thus people do not need to see unnecessary error information from ones invoking the bot. Ignore all the things that it's not exact match and make them report bugs if there is one.
5. URLs should be hyperlinks. There is no need to openly post the URL itself.
6. Multiple query answers look really really bad. Help for x, Help for y, Help for that, Help for this; do you think it's a need to add help for to every entry?

Solution

• Consistent design. Just one template and no more.
• No redundant information.
• Bot simply doesn't work when it's not provided with the query it needs.
• Some people read r/vim quite frequently and it should be pleasant look at, not make you bothered like when you see an ad that you have already seen.

Single entry

Multiple entries

Markdown

help pages for:

* [`'compatible'`](https://vimhelp.org/options.txt.html#%27compatible%27)
* [`'complete'`](https://vimhelp.org/options.txt.html#%27complete%27)

---

^(\`:help <query>\` |) [^(source)](https://github.com/Herald-Of-Solace/VimHelpBot) ^(|) [^(mistake?)](https://github.com/Herald-Of-Solace/VimHelpBot/issues/new/choose)

[heraldofsolace]

Thanks for your help! I have added a commit that improves the style.

[kutsan]

(h|he|hel|help)

This is not necessary, makes it bad UI. Simply make it :help or :h. No one uses :he or :hel even. Of course, it should work with every four possibilities but you don't need to show three of them at the first glance. I think you should make it clean by simply showing one of them. It should be :help.

[heraldofsolace]

Should we then show :(h|help). I think these two are the most used

[kutsan]

Yes, that works too. I would have gone with :help only but it's your decision.

[kutsan]

We can also include the file they're in, in italic style, what do you think?

• 'compatible' in options.txt
• pattern in pattern.txt

* [`'compatible'`](https://vimhelp.org/options.txt.html#%27compatible%27) in _options.txt_
* [`pattern`](https://vimhelp.org/pattern.txt.html#pattern) in _pattern.txt_

[heraldofsolace]

Yes, that'd be nice to have.

[kutsan]

Great bot by the way. Thanks for making this.

[heraldofsolace]

Thanks for your valuable suggestions too 😊

[heraldofsolace]

Formatting is broken on Mobile (using Boost)

And Reddit PC notification

[kutsan]

Hmm, I don't know why. I'm using reddit desktop with the new design and reddit official mobile app on mobile. I haven't had any problem so far.

But you seems to fixed it.

[heraldofsolace]

Turns out Old reddit has problems with superscript with parentheses.