apollo/enbas
1
0
Fork 0
Code Issues 4 Pull requests Projects Activity Actions

update documentation
All checks were successful
Tests / test (pull_request) Successful in 19s
Details

Browse source
This commit is contained in:
Dan Anglin 2024-08-19 22:22:15 +01:00
parent ef3baf7ba6
commit 72caa3efb4
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/manual.md
View file

@ -533,7 +533,7 @@ Additional flags for polls.
| `poll-allows-multiple-choices` | boolean | false | Set to `true` to allow users to make multiple choices. | false | | `poll-allows-multiple-choices` | boolean | false | Set to `true` to allow users to make multiple choices. | false |
| `poll-hides-vote-counts` | boolean | false | Set to `true` to hide the vote count until the poll is closed. | false | | `poll-hides-vote-counts` | boolean | false | Set to `true` to hide the vote count until the poll is closed. | false |
| `poll-option` | string | true | An option in the poll. Use this flag multiple times to set multiple options. | | | `poll-option` | string | true | An option in the poll. Use this flag multiple times to set multiple options. | |
| `poll-expires-in` | string | false | The duration in which the poll is open for. | | | `poll-expires-in` | [time duration value](tips_and_tricks.md#the-time-duration-value) | false | The duration in which the poll is open for. | |
### Delete a status ### Delete a status

12
docs/tips_and_tricks.md
View file

@ -4,15 +4,15 @@
The time duration value is a custom [flag value](https://pkg.go.dev/flag#Value) that converts a string input into a duration of time. The time duration value is a custom [flag value](https://pkg.go.dev/flag#Value) that converts a string input into a duration of time.
A typical string input would be in the form of something like `"3 days, 12 hours and 39 minutes"`. A typical string input would be in the form of something like `"3 days, 12 hours and 39 minutes"`.
The value can parse units in days, hours, minutes and seconds. The value can convert units in days, hours, minutes and seconds.
To ensure that your string input is parsed correctly there are simple rules to follow. To ensure that your string input is converted correctly there are simple rules to follow.
- The input must be wrapped in quotes. - The input must be wrapped in quotes.
- Use `day` or `days` to parse the number of days. - Use `day` or `days` to convert the number of days.
- Use `hour` or `hours` to parse the number of hours. - Use `hour` or `hours` to convert the number of hours.
- Use `minute` or `minutes` to parse the number of minutes. - Use `minute` or `minutes` to convert the number of minutes.
- Use `second` or `seconds` to parse the number of seconds. - Use `second` or `seconds` to convert the number of seconds.
- There must be at least one space between the number and the unit of time.<br> - There must be at least one space between the number and the unit of time.<br>
E.g. `"7 days"` is valid, but `"7days"` is invalid. E.g. `"7 days"` is valid, but `"7days"` is invalid.