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

docs: Fix typos #472

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
3 participants
@marschall
Contributor

marschall commented Dec 28, 2015

Fix a few typos in the comments.

@davecramer

This comment has been minimized.

Member

davecramer commented Dec 28, 2015

Believe it or not I think occurred was fixed once already ;)

Dave Cramer

On 28 December 2015 at 07:14, Philippe Marschall notifications@github.com
wrote:

Fix a few typos in the comments.

You can view, comment on, or merge this pull request online at:

#472
Commit Summary

  • docs: Fix typos

File Changes

Patch Links:


Reply to this email directly or view it on GitHub
#472.

@vlsi

This comment has been minimized.

Member

vlsi commented Dec 28, 2015

Can we add a checkstyle rule to catch those kind of things?
@marschall , would you please do that?

@marschall

This comment has been minimized.

Contributor

marschall commented Dec 28, 2015

@vlsi a rule for what? spell checking or just "occured"?

@vlsi

This comment has been minimized.

Member

vlsi commented Dec 28, 2015

Well, if you would be able to configure a spellchecker, that would be good.
Otherwise just a couple of well-known "occurencies" might do in checkstyle config.

@davecramer

This comment has been minimized.

Member

davecramer commented Dec 28, 2015

How do spell checkers work with variables ? Does it only check spelling in
comments ?

Dave Cramer

On 28 December 2015 at 07:46, Vladimir Sitnikov notifications@github.com
wrote:

Well, if you would be able to configure a spellchecker, that would be good.
Otherwise just a couple of well-known "occurencies" might do in checkstyle
config.


Reply to this email directly or view it on GitHub
#472 (comment).

@vlsi

This comment has been minimized.

Member

vlsi commented Dec 28, 2015

How do spell checkers work with variables ? Does it only check spelling in
comments ?

It is somewhat hard to google for "spell checker for java sources".

However the following might be feasible:

  1. Our JRE8 build produces javadocs. We might spell-check those docs which are HTMLs.
    or
  2. pre-process all the sources, leaving just comments, then spell-check the result.
@marschall

This comment has been minimized.

Contributor

marschall commented Dec 28, 2015

One problem with general spell checkers is that there are a lot of technical terms like "sql" in the source that are often not recognized. As for checkstyle the only option short of writing a custom module would be to use the Regexp module to search for known offenders. Let me know if I should do this. Anything more complex should IMO be moved to a different issue. One issue with just checking the Javadoc output is that about half the typos were in non-Javadoc comments.

@vlsi

This comment has been minimized.

Member

vlsi commented Dec 28, 2015

Ok, let's start with listing common offenders in checkstyle configuration.

@davecramer

This comment has been minimized.

Member

davecramer commented Dec 28, 2015

This is pretty low priority...IMHO

Dave Cramer

On 28 December 2015 at 08:32, Philippe Marschall notifications@github.com
wrote:

One problem with general spell checkers is that there are a lot of
technical terms like "sql" in the source that are often not recognized. As
for checkstyle the only option short of writing a custom module would be to
use the Regexp http://checkstyle.sourceforge.net/config_regexp.html
module to search for known offenders. Let me know if I should do this.
Anything more complex should IMO be moved to a different issue. One issue
with just checking the Javadoc output is that about half the typos were in
non-Javadoc comments.


Reply to this email directly or view it on GitHub
#472 (comment).

docs: Fix typos
Fix a few typos in the comments and add checkstyle rules for common offenders.

@marschall marschall force-pushed the marschall:typos branch from c8ea57a to 18bb90c Dec 28, 2015

@vlsi vlsi closed this in 7564895 Dec 29, 2015

vlsi added a commit that referenced this pull request Dec 29, 2015

vlsi added a commit that referenced this pull request Dec 29, 2015

vlsi added a commit that referenced this pull request Dec 29, 2015

vlsi added a commit that referenced this pull request Dec 29, 2015

vlsi added a commit that referenced this pull request Dec 29, 2015

vlsi added a commit that referenced this pull request Dec 29, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment