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

Move UTF-8 limitation info in documentation #6083

Closed
SebastianDietrich opened this Issue Aug 14, 2018 · 9 comments

Comments

Projects
None yet
5 participants
@SebastianDietrich
Copy link

SebastianDietrich commented Aug 14, 2018

Should be documented as general limitation in http://checkstyle.sourceforge.net/index.html. As of now (http://checkstyle.sourceforge.net/writingchecks.html#Limitations) it is written like it was a limitation for writing own checks (and not for code that checkstyle checks).

@romani

This comment has been minimized.

Copy link
Member

romani commented Aug 14, 2018

Source of idex page is at https://github.com/checkstyle/checkstyle/blob/master/src/xdocs/index.xml.vm , limitation section could simply moved to index page.
Everyone is welcome with PR to make it happen

@rnveach rnveach added the easy label Aug 15, 2018

@raychou1203

This comment has been minimized.

Copy link

raychou1203 commented Oct 23, 2018

Where to put the Limitation or Note at http://checkstyle.sourceforge.net/index.html ?, I think create a new section named Notices like <section name="Notes"> will be a good idea. If so , please assign it to me.

@raychou1203

This comment has been minimized.

Copy link

raychou1203 commented Oct 23, 2018

@romani

This comment has been minimized.

Copy link
Member

romani commented Oct 23, 2018

we need to move second paragraph from https://checkstyle.org/writingchecks.html#Limitations to index page under "Development Cycle" as new section "Limitations".
we need tp reword "You cannot " to "Checkstyle cannot".

@raychou1203 , you are always welcome, if issue is not assigned to anybody , simply make a comment "I am on it" and do contribution.

@fzdy1914

This comment has been minimized.

Copy link
Contributor

fzdy1914 commented Feb 12, 2019

@raychou1203 Are you still working on this?

@rnveach

This comment has been minimized.

Copy link
Member

rnveach commented Feb 12, 2019

@fzdy1914 there has be no activity since October. Feel free to work on it.

@fzdy1914

This comment has been minimized.

Copy link
Contributor

fzdy1914 commented Feb 12, 2019

@rnveach Can I use what he had done and mention that he is the coauthor of the commit?

@rnveach

This comment has been minimized.

Copy link
Member

rnveach commented Feb 12, 2019

Yes you can use his commit. We usually don't write authors in the code/documentation. If you mean on the commit level, that may be erased when the commit is merged as it sets the admin who merged it as the committer. See https://github.com/checkstyle/checkstyle/commits/master

@romani

This comment has been minimized.

Copy link
Member

romani commented Feb 12, 2019

usually 2nd author completely replace original author, as code is technically dead.
You can mention original author in commit message as some sort of gratitude if amount of code is significant, but it completely up to you.

fzdy1914 added a commit to fzdy1914/checkstyle that referenced this issue Feb 13, 2019

fzdy1914 added a commit to fzdy1914/checkstyle that referenced this issue Feb 13, 2019

fzdy1914 added a commit to fzdy1914/checkstyle that referenced this issue Feb 17, 2019

fzdy1914 added a commit to fzdy1914/checkstyle that referenced this issue Feb 17, 2019

fzdy1914 added a commit to fzdy1914/checkstyle that referenced this issue Feb 17, 2019

fzdy1914 added a commit to fzdy1914/checkstyle that referenced this issue Feb 17, 2019

rnveach added a commit that referenced this issue Feb 17, 2019

@rnveach rnveach added this to the 8.18 milestone Feb 17, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.