[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15982732#comment-15982732
 ] 

ASF GitHub Bot commented on IGNITE-5018:


Github user oignatenko closed the pull request at:

https://github.com/apache/ignite/pull/1837


> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>  Components: ml
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[Oleg Ignatenko (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15981036#comment-15981036
 ] 

Oleg Ignatenko commented on IGNITE-5018:


Thank you [Anton 
Vinogradov|https://issues.apache.org/jira/secure/ViewProfile.jspa?name=avinogradov]
 - reference to [commit 
7378bc3|https://github.com/apache/ignite/commit/7378bc38abf8ec6ed8aca9c3608eec00f1a86fb2]
 was really helpful. I see now that it would be possible to find the issue by 
checking the code against 
[guidelines|https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines]
 but that would probably take much more time.

[Denis 
Magda|https://issues.apache.org/jira/secure/ViewProfile.jspa?name=dmagda] just 
letting you know that this was merged as you asked.

> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>  Components: ml
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[Oleg Ignatenko (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15979816#comment-15979816
 ] 

Oleg Ignatenko commented on IGNITE-5018:


[Anton 
Vinogradov|https://issues.apache.org/jira/secure/ViewProfile.jspa?name=avinogradov],

I would much appreciate if you re-run your checks on [pull request 
1837|https://github.com/apache/ignite/pull/1837] (branch ignite-5018-2) when 
you have time.

I possibly fixed some of the style violations but based on your review comments 
it seems that there are at least 3 files that are still wrong there (maybe 
more). So far I could not find remaining troublesome files.

If you can tell what file(s) fail your checks this would help me faster find 
out what is still wrong with my IDE settings. Even one example violation would 
help me pinpoint my problem.

Thanks

> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>  Components: ml
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[Denis Magda (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15979535#comment-15979535
 ] 

Denis Magda commented on IGNITE-5018:
-

[~oignatenko], please make sure to squeeze it into 2.0. As far as I understand, 
the 2.0 branch will be frozen the next week.

> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>  Components: ml
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[Oleg Ignatenko (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15978717#comment-15978717
 ] 

Oleg Ignatenko commented on IGNITE-5018:


Confirmed reviewer evaluation [in prior 
comment|https://issues.apache.org/jira/browse/IGNITE-5018?focusedCommentId=15978493=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-15978493].

I more closely checked my IDE settings and these turned out broken. After 
correcting code style settings to idea/ignite_codeStyle.xml I've got report of 
the errors closely matching one reported by reviewer (mine report was from 34 
files instead of 37 but that's probably yet another mistake in my IDE config).

Corrections per properly configured code style were pushed to same branch 
ignite-5018-2, I plan to take yet another look at the code in this branch later 
to make sure if I haven't missed something else.

> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>  Components: ml
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[Anton Vinogradov (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15978493#comment-15978493
 ] 

Anton Vinogradov commented on IGNITE-5018:
--

[~oignatenko],
Proposed pull request can't be merged, now I see 37 files with broken code 
style.

1) Please follow projects requirements instead of reinventing the wheel.
Code style can be fixed and checked using IDEA's codestyle from 
idea/ignite_codeStyle.xml
Please check next pullrequest using this tool before proposing.
2) Next time, please, ask commiter directly (using @ ...) to merge or to review 
your changes.

Thanks.

> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>  Components: ml
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[Oleg Ignatenko (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15976484#comment-15976484
 ] 

Oleg Ignatenko commented on IGNITE-5018:


(i) pull request to address the issues raised in prior comments: 
https://github.com/apache/ignite/pull/1837

> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15976482#comment-15976482
 ] 

ASF GitHub Bot commented on IGNITE-5018:


GitHub user oignatenko opened a pull request:

https://github.com/apache/ignite/pull/1837

IGNITE-5018 Javadocs in Ignite ML module.

- compliance with coding guidelines
  (rev 17 at 
https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines)
- verified with diffs overview and execution of code style inspections.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/gridgain/apache-ignite ignite-5018-2

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/ignite/pull/1837.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #1837


commit 38c3d60fc619e690e0b5980de98b95081576560b
Author: Oleg Ignatenko 
Date:   2017-04-20T10:49:58Z

IGNITE-5018 Javadocs in Ignite ML module.
- compliance with coding guidelines
  (rev 17 at 
https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines)
- verified with diffs overview and execution of code style inspections.




> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[Denis Magda (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15975948#comment-15975948
 ] 

Denis Magda commented on IGNITE-5018:
-

[~oignatenko], I tend to agree with Anton that every Apache Ignite contributor 
has to follow well-established coding guidelines. Please, just spend some extra 
time fixing the style. This makes our code looks identical across all the 
modules we have. The ML Grid shouldn't be an exception. Honestly, all we went 
through this exercise when we're committing our first changes to Ignite :)

> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[Anton Vinogradov (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15975098#comment-15975098
 ] 

Anton Vinogradov commented on IGNITE-5018:
--

After merge I found that ML module does not match project requirements:
https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines

I've found at least 26 files with wrong code style using automatical formatting 
using IDEA's codestyle from idea/ignite_codeStyle.xml

most of found related to javadoc
Provided:
{noformat}
/** */ private IgniteFunction getFunc;
/** */ private IntDoubleToVoidFunction setFunc;
/** */ private int size;

{noformat}

Correct:
{noformat}
/** */
private IgniteFunction getFunc;
/** */
private IntDoubleToVoidFunction setFunc;
/** */
private int size;
{noformat}

Formatting and abbreviations should be checked prior to any merge request.
Hope this will be checked and fixed before next merge and/or on each commiters 
request.




> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (IGNITE-5018) review and improve javadocs in ML module

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15974412#comment-15974412
 ] 

ASF GitHub Bot commented on IGNITE-5018:


GitHub user ybabak opened a pull request:

https://github.com/apache/ignite/pull/1829

IGNITE-5018 Javadocs in Ignite ML module.

- verified with diffs overview and execution of code style inspections.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/gridgain/apache-ignite ignite-5018

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/ignite/pull/1829.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #1829


commit 5e5ae7aa3bee21ba15c517746b18cb6f8f494568
Author: Oleg Ignatenko 
Date:   2017-04-19T08:53:33Z

IGNITE-5018 Javadocs in Ignite ML module.
- verified with diffs overview and execution of code style inspections.




> review and improve javadocs in ML module
> 
>
> Key: IGNITE-5018
> URL: https://issues.apache.org/jira/browse/IGNITE-5018
> Project: Ignite
>  Issue Type: Task
>Reporter: Oleg Ignatenko
>Assignee: Oleg Ignatenko
>Priority: Minor
> Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To 
> name a few, add descriptions for constructor parameters in classes 
> {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)