Merged
Conversation
mvidner
reviewed
Jul 25, 2023
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 | | |
Contributor
There was a problem hiding this comment.
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.
Suggested change
| | 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 | | |
Contributor
Author
There was a problem hiding this comment.
yeah, makes sense
joseivanlopez
approved these changes
Jul 26, 2023
Contributor
There was a problem hiding this comment.
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.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Answers file supports various questions, but there is no central place for list of current questions and its answers.
Solution
Document it.