-
Notifications
You must be signed in to change notification settings - Fork 43
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.
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
create table with question types #673
Conversation
doc/questions.md
Outdated
|
||
| class | description | possible answers | available data | notes | | ||
|--- |--- |--- |--- |--- | | ||
| software.medium\_error | When there is issue with access to medium | `Retry` `Skip` | `url` with url where failed access happen | | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With this style it will be easier to keep the docs up to date in case we ever rename a class and grep for it in the repo.
| software.medium\_error | When there is issue with access to medium | `Retry` `Skip` | `url` with url where failed access happen | | | |
| `software.medium_error` | When there is issue with access to medium | `Retry` `Skip` | `url` with url where failed access happen | | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, makes sense
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
About inconsistency with the answers, originally the idea was to have some kind of key for each possible answer: "yes", "no", "maybe", etc. And the clients are responsible of presenting a readable text to the user, for example:
yes -> Accept
no -> Cancel
maybe -> Decide later
I guess software has capitalize answers because the web client is directly using the answers as text. IMHO, I would avoid that.
Problem
Answers file supports various questions, but there is no central place for list of current questions and its answers.
Solution
Document it.