Remove the description/workaround fields from Error definition#31
Merged
crazycs520 merged 3 commits intomasterfrom Oct 29, 2020
Merged
Remove the description/workaround fields from Error definition#31crazycs520 merged 3 commits intomasterfrom
crazycs520 merged 3 commits intomasterfrom
Conversation
Signed-off-by: Lonng <heng@lonng.org>
kennytm
reviewed
Oct 29, 2020
normalize.go
Outdated
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "go.uber.org/atomic" |
Collaborator
There was a problem hiding this comment.
keep this separate from the standard library imports
Co-authored-by: kennytm <kennytm@gmail.com>
Signed-off-by: Lonng <heng@lonng.org>
lucklove
approved these changes
Oct 29, 2020
crazycs520
approved these changes
Oct 29, 2020
This was referenced Nov 9, 2020
This was referenced Nov 10, 2020
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
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.
Signed-off-by: Lonng heng@lonng.org
The fields
descriptionandworkaroundare introduced because we want the user to inject the value via hard code in the original implementation, but we found it's hard to contribute by non-developers.I proposed a new solution to solve this situation, and the new solution allows all users to contribution
descriptionandworkaroundby edition the generatederrors.tomldirectly and theerrdoc-gen(https://github.com/pingcap/tiup/tree/master/components/errdoc/errdoc-gen) merge them when generating the metafile. So we don't need these two fields anymore.Ref: pingcap/tiup#867