Done Clean up & update error message for !faq

Shaymin Sky

This again? Alpha?
is a Community Contributor
Currently if you do !faq for an invalid topic you get-
1746691036002.png



This is unintuitive, doesn't look good, and the message itself is confusing? To elaborate on the unintuitive part, the only people who are broadcasting faq's are 99% gonna be staff with the 1% rare chance of a regular broadcasting a faq in PM's to someone. The purpose of the broadcast faq is to answer questions, however a failed broadcast for a FAQ going through just serves to be annoying to staff/confuse users who see the failed broadcast and for that same reason a failed !rfaq doesn't go through and it only returns the error message. it makes no sense that a failed !rfaq only sends the error return message (which is more convenient), while failed !faq sends the failed broadcast to chat AND the error message?? We should have the failed FAQ broadcast function like a failed RFAQ broadcast.

And lastly the /faq help explanation is very poor. "Provides a link to the FAQ" and "add for all of them" is comically vague, a link that does what? "add all for all of them"- what's "add all to all of them"? that's not proper grammar and im pretty sure some poor soul has tried /faq autoconfirmed, badges, proxy etc- thinking literally add all. These faqs are designed for complete new users of varying levels of English proficiency given how wide P.S in language and age so clarifying the help message is needed in my opinion. Also there's straight up FAQ's missing from the list provided like 'customavatar'. Something like this could maybe work-

"/faq [topic] - Provides a link that answers the FAQ topic. The list of FAQ's is: autoconfirmed, badges, customavatar, decay, ladder, lostpassword, privacy, proxy, rng, staff, tiers, tournaments."

RFAQ's use the term topic so unifying this with the faq command helps, also "theme" is pretty vague too.


EDIT: If this is approved I'll work on this as well.
 
Last edited:
Ok after about a week because it was surprisingly more annoying than I thought but

OLD:
1747521621339.png



IMPROVED:
1747522164403.png
(commands in the improved screenshot are in the same order from the 'old' screenshot, have to note this since it doesn't show the message)
!faq fails no longer send the failed message message in chat, this is very helpful for room auth who are the users of broadcast commandsFor whatever reason '!faq all' fails used a replybox? I can't think of a single non dev command that uses visible replyboxes in chat for fails, so changed this for an errorReply.
I cleaned up the wording of the /help faq, and I added some topics that were not there previously!
Making PR for this in a few minutes, can update this thread to in progress.

EDIT: I changed the wording in the faq help of "List of FAQ's" to "List of FAQ topics" for added clarity
 
My PR for this was merged a bit ago and was just hotpatched thanks to dhelmise, this is now implemented and can be tagged as 'done'


wooo
 
Back
Top