The Telegram bot @roolsbot serves the python-telegram-bot group chats by announcing the rules and searching the docs & wiki of python-telegram-bot
So what exactly can this bot do?
You can use the inline mode to search for entries in the documentation or the wiki. Simply type @roolsbot <your search keywords> and select one of the results. To search exclusively within the code snippets or FAQ, type @roolsbot snippets/faq <your search keywords>.
To nicely insert those links directly into your message, you can enclose the search keywords by +, e.g.
@roolsbot I 💙 +InlineQueries+, but you need an +InlineQueryHandler+ for it.
becomes
I 💙 InlineQueries, but you need an InlineQueryHandler for it.
You can also choose to include links to the official Bot API docs, where available.
All search is fuzzy, i.e. a few typos won't matter.
The inline mode can also be used to search for threads and commits in the GitHub repository of python-telegram-bot. Simply type @roolsbot <your query> and select the result. The search query may be of the form
ptbcontrib/namewith the (directory) name of a contribution of ptbcontrib#numberwith the number of an issue/pull request#phareswith a phrase to search for in issue/pull request titles@shawith a commit SHA
In the list three cases, # may be replaced by GH- or PR- and you can prepend
repoto search in the repohttps://github.com/python-telegram-bot/repoowner/to search in the repohttps://github.com/owner/repo
Of course, you can also insert those links directly into your message, e.g.
@roolsbot Pull Request #1920 is about #TypeHinting.
rules-bot provides a number of predefined messages that are frequently needed. A list of available tag hints is available via the /hints command. Simply send #<taghint> and rules-bot will delete your message and send the corresponding text instead. Reply to a message with #<taghint> to make rules-bot send the message as reply to that message. Type #<taghint> <a personal message>, to insert the personal message at a meaningful spot within the message. For most tag hints this will just prepend the personal message. You can even send multiple short messages at once by typing #<taghint 1> <message 1> #<taghint 2> <message 2> ...
Tag hints are also available via the inline mode. Typing @roolsbot #taghint allows you to send the message yourself instead of having rules-bot send it. Personal messages work just like described above, though inline mode only supports one tag hint at a time.
rules-bot does a number of things without explicitly requesting it. This includes:
To redirect a user to the on-/off-topic group simply reply with on-topic or off-topic to their message. rules-bot accepts different variants of this (e.g. #off-topic, offtopic, off topic are valid) and the hint may also be part of a longer message.
When mentioning issues, pull requests, commit SHAs or ptbcontrib contributions in the same manner as described above in Search GitHub, rules-bot will automatically reply to your message with the corresponding links. If your message is a reply to another message, the links will be sent as reply to that message.
rules-bot will automatically delete the service messages announcing new members. Instead, it will welcome new members by mentioning them in a short message that links to a message stating the rules of the group. New members are welcomed in batches. Currently, there will be at most one welcoming message per hour. The linked rules messages are updated with the current rules on start-up.
/docs: Sends the link to the docs./wiki: Sends the link to the wiki./hints&/listhints: Sends a list of available tag hints (see here)/help: Links to this readme.
rules-bot can make sandwiches. You can ask it to do so by typing make me a sandwich. We'll see, if it actually does 😉