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

Update doc for MutableException #7613

Closed
pbludov opened this issue Feb 24, 2020 · 4 comments · Fixed by #12371
Closed

Update doc for MutableException #7613

pbludov opened this issue Feb 24, 2020 · 4 comments · Fixed by #12371

Comments

@pbludov
Copy link
Member

pbludov commented Feb 24, 2020

https://checkstyle.org/config_design.html#MutableException

Add example for each existing config to show what code is ok and what code cause violation.
Good example is https://checkstyle.org/config_naming.html#AbstractClassName
Look at referenced commits of #5832, to see what and how should be changed in code.

Please play with module/check by means of https://checkstyle.org/cmdline.html to understand how it works.


PLEASE READ https://github.com/checkstyle/checkstyle/wiki/Good-practice-on-how-to-update-examples

@ShubhraSuman
Copy link

I am on it.

@ShubhraSuman
Copy link

Do I need to write example for both properties or one is fine? Since both of them have same default values.

name description type default value

  • format Specify pattern for exception class names. Pattern "^.*Exception$|^.*Error$|^.*Throwable$"
  • extendedClassNameFormat. Specify pattern for extended class names Pattern "^.*Exception$|^.*Error$|^.*Throwable$"

@romani
Copy link
Member

romani commented Mar 29, 2022

For both, and both should have custom values (not defaults)

@arinmodi
Copy link
Contributor

arinmodi commented Nov 5, 2022

@pbludov, I made a PR on this, can you please review that ?

arinmodi added a commit to arinmodi/checkstyle that referenced this issue Nov 5, 2022
arinmodi added a commit to arinmodi/checkstyle that referenced this issue Nov 5, 2022
arinmodi added a commit to arinmodi/checkstyle that referenced this issue Nov 6, 2022
arinmodi added a commit to arinmodi/checkstyle that referenced this issue Nov 6, 2022
arinmodi added a commit to arinmodi/checkstyle that referenced this issue Nov 6, 2022
arinmodi added a commit to arinmodi/checkstyle that referenced this issue Nov 6, 2022
arinmodi added a commit to arinmodi/checkstyle that referenced this issue Nov 6, 2022
arinmodi added a commit to arinmodi/checkstyle that referenced this issue Nov 6, 2022
arinmodi added a commit to arinmodi/checkstyle that referenced this issue Nov 7, 2022
@romani romani added this to the 10.5 milestone Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants