2 upvotes, 1 direct replies (showing 1)
View submission: Introducing Flair_Helper
I suggest a link ...
Good point! Done.
Note that it doesn't work on mod posts, if I'm correct about that limitation.
It will not work on your own posts due to a limitation of reddit: flairing one's one post does not count as a mod action, even if you use a mod flair to do it. It will still work if you flair another mod's post.
There's a discrepancy between the format shown ...
You are correct that it doesn't make a difference in this case. Users of Flair_Helper are expected to familiarize themselves with YAML syntax to some degree and the differences are intended to demonstrate that there are multiple ways to write the same thing in YAML. Perhaps it would help to put variations within the examples page itself.
Because of markdown, there's a difference between ...
Users are similarly expected to be familiar with markdown syntax, especially since they're necessarily reddit mods. There isn't really anything I can do to change the way the wiki page renders, so I'm not totally sure what you're suggesting here.
Comment by tuctrohs at 01/08/2020 at 13:27 UTC
1 upvotes, 1 direct replies
Thanks for setting up the wiki index.
It's not your responsibility to educate mods on YAML, and it's reasonable to provide a tool that advances the capabilities of mods who are familiar with it, without taking responsibility for making it accessible to any mods. But at the same time, if there are little things you can do to make it more accessible, why not?
My suggestion about the issue of your own posts was not that you should change the way it behaves. I understand that that's a limitation of Reddit, not a bug in your code. My suggestion is to add a note to that effect to your documentation. Maybe at the end of the quick start guide: a bullet that said "test your new setup, but not on your own post: make a test post from an alt account. (Explain why)"
On the last point, what I'm suggesting is just a note that says
the *source* on your wiki page should appear the way the examples are rendered. The rendering of your wiki page will be different, but you can ignore that.
There are two versions of the example page: source (Se) and rendering (Re). There are two versions of the actual wiki: source (Sw) and rendering (Rw). You are following a highly logical, but unstated convention that Re shoud match Sw. I'm not suggesting changing your convention, but am merely suggesting stating your convention.
You say that mods should know markdown. If they do, they know about the two versions of each page. But they don't know *for sure* which of the four possible conventions you are following. Again, your convention is absolutely the most logical, but when it doesn't work and you don't know why, having that simple statement can short-circuit that doubt.
Also, not all mods are good with things like markdown. Some mods are mods because they are subject experts on the topic of the sub, which might be, for example, diesel engine lubrication. One of the reasons your bot is useful is that it can help people like that perform mod functions easily. And one of the stated purposes of your documentation is, for example, to help someone who inherited a sub with Flair_Helper set up understand how to use it.