xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

bots: Modify howdoi/readme.md to correctly call 'howdoi' bot.

Browse source 
Update images with new commands screenshots for better understanding.
This commit is contained in:
Abhijeet Kaur 2017-07-20 18:27:58 +05:30 committed by Tim Abbott
parent d9a6fec1a0
commit 2e48392884
3 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
zulip_bots/zulip_bots/bots/howdoi/assets/question_howdoi_all.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9 KiB

After

Width:  |  Height:  |  Size: 12 KiB

BIN
zulip_bots/zulip_bots/bots/howdoi/assets/question_howdowe.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 12 KiB

20
zulip_bots/zulip_bots/bots/howdoi/readme.md
View file

@ -11,17 +11,17 @@ Simply prepend your questions with one of the following commands. The
answer will be formatted differently depending the chosen command. answer will be formatted differently depending the chosen command.
| Command | Respond | | Command | Respond |
| ----------- | ------------------------------------------------------ | | ----------------------- | ------------------------------------------------------ |
| `@howdowe` | Concise answer to the same stream. | | `@mention-bot howdowe` | Concise answer to the same stream. |
| `@howdowe!` | Same as `@howdowe` but with full answer and URL of the solutions. | | `@mention-bot howdowe!` | Same as `@mention-bot howdowe` but with full answer and URL of the solutions. |
| `@howdoi` | Concise answer replied to sender via private message. | | `@mention-bot howdoi` | Concise answer replied to sender via private message. |
| `@howdoi!` | Same as `@howdoi` but with full answer and URL of the solutions. | | `@mention-bot howdoi!` | Same as `@mention-bot howdoi` but with full answer and URL of the solutions. |
## Screenshots ## Screenshots
#### Example 1 #### Example 1
Question -> `@howdowe use supervisor in elixir` Question -> `@mention-bot howdowe use supervisor in elixir`
![howdowe question](assets/question_howdowe.png) ![howdowe question](assets/question_howdowe.png)
@ -32,7 +32,7 @@ of the answer.
#### Example 2 #### Example 2
Question -> `@howdoi! stack vs heap` Question -> `@mention-bot howdoi! stack vs heap`
![howdoi! question](assets/question_howdoi_all.png) ![howdoi! question](assets/question_howdoi_all.png)
@ -51,6 +51,6 @@ This could be adjusted in the source code (`HowdoiHandler.MAX_LINE_LENGTH`).
instead of a complete sentences (eg: "How do i make a decorator in Python" instead of a complete sentences (eg: "How do i make a decorator in Python"
-> "python decorator"). -> "python decorator").
* __[*Limitation*]__ If a answer contains multiple code blocks, the `@howdoi` * __[*Limitation*]__ If a answer contains multiple code blocks, the `@mention-bot howdoi`
and `@howdowe` commands would only return the first coding section, use and `@mention-bot howdowe` commands would only return the first coding section, use
`@howdo[we|i]!` in that case. `@mention-bot howdo[we|i]!` in that case.