Skip to content

baremetrics: Fix doc.md to match current bot documentation standards. #911

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hanyucrocks wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −8
Open

baremetrics: Fix doc.md to match current bot documentation standards. #911

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions zulip_bots/zulip_bots/bots/baremetrics/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,7 @@ To do this, follow the given steps:
3. Open up `zulip_bots/bots/baremetrics/baremetrics.conf` in an editor and
change the value of the `<api_key>` attribute to the noted `Live API Key`.

## Developer Notes

Be sure to add the command and its description to their respective lists (named `commands` and `descriptions`)
so that it can be displayed with the other available commands using `@<botname> list-commands`. Also modify
the `test_list_commands_command` in `test_baremetrics.py`.
Run this bot as described in [here](https://zulip.com/api/running-bots#running-a-bot).

## Links

Expand All @@ -35,7 +31,5 @@ the `test_list_commands_command` in `test_baremetrics.py`.
## Usage

`@Baremetrics list-commands` - This command gives a list of all available commands along with short
short descriptions.

Example:
descriptions. Example usage: `@Baremetrics list-commands`:
![](assets/list-commands.png)
Loading