Skip to content
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

[enhancement](style): polish the checkstyle #9767

Merged
merged 2 commits into from
May 30, 2022
Merged

Conversation

jackwener
Copy link
Member

Proposed changes

Issue Number: close #xxx

Problem Summary:

Describe the overview of changes.

  • cancel the auto-align in Javadoc
@ param1       desc
@ paramExample desc
  • polish doc for checkstyle

Checklist(Required)

  1. Does it affect the original behavior: (No)
  2. Has unit tests been added: (No)
  3. Has document been added or modified: (yes)
  4. Does it need to update dependencies: (no)
  5. Are there any changes that cannot be rolled back: (No)

Further comments

If this is a relatively large or complex change, kick off the discussion at dev@doris.apache.org by explaining why you chose the solution you did and what alternatives you considered, etc...

@github-actions github-actions bot added the kind/docs Categorizes issue or PR as related to documentation. label May 25, 2022
@adonis0147
Copy link
Contributor

Hi @jackwener , would you like to translate the notes in English and use them in snapshot (idea-checkstyle-plugin.png)?

@jackwener
Copy link
Member Author

Hi @jackwener , would you like to translate the notes in English and use them in snapshot (idea-checkstyle-plugin.png)?

I think it's unnecessary, because English doc is exist.

image

@adonis0147
Copy link
Contributor

Ok, you didn't use the snapshot in the English docs.

@adonis0147
Copy link
Contributor

LGTM

morrySnow
morrySnow previously approved these changes May 27, 2022
Copy link
Contributor

@morrySnow morrySnow left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@morningman morningman left a comment

Choose a reason for hiding this comment

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

Better to use English in image.

@jackwener
Copy link
Member Author

Better to use English in image.

fixed

Copy link
Contributor

@yiguolei yiguolei left a comment

Choose a reason for hiding this comment

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

LGTM

@yiguolei yiguolei merged commit 46e84d3 into apache:master May 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants