Skip to content

Remove the description/workaround fields from Error definition#31

Merged
crazycs520 merged 3 commits intomasterfrom
remove-desc-wa
Oct 29, 2020
Merged

Remove the description/workaround fields from Error definition#31
crazycs520 merged 3 commits intomasterfrom
remove-desc-wa

Conversation

@lonng
Copy link

@lonng lonng commented Oct 29, 2020

Signed-off-by: Lonng heng@lonng.org

The fields description and workaround are 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 description and workaround by edition the generated errors.toml directly and the errdoc-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

Copy link
Collaborator

@kennytm kennytm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rest LGTM

normalize.go Outdated
import (
"encoding/json"
"fmt"
"go.uber.org/atomic"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keep this separate from the standard library imports

lonng and others added 2 commits October 29, 2020 12:06
Co-authored-by: kennytm <kennytm@gmail.com>
Signed-off-by: Lonng <heng@lonng.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants