You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@systemml.apache.org by "Deron Eriksson (JIRA)" <ji...@apache.org> on 2017/03/17 18:28:41 UTC
[jira] [Comment Edited] (SYSTEMML-1406) Fix whitespace issues in
main algorithms
[ https://issues.apache.org/jira/browse/SYSTEMML-1406?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15930413#comment-15930413 ]
Deron Eriksson edited comment on SYSTEMML-1406 at 3/17/17 6:28 PM:
-------------------------------------------------------------------
Hi [~mboehm7]. If we standardize, I think it may actually be better to use spaces rather than tabs. The reasoning for this is because spaces always render the same in all environments whereas tabs can be unpredictable.
As an example, here are two DML comment blocks, one formatted with spaces and the other formatted with tabs. The formatting looks identical for me in Eclipse:
Spaces:
{code}
#
# INPUT PARAMETERS:
# ---------------------------------------------------------------------------------------------
# NAME TYPE DEFAULT MEANING
# ---------------------------------------------------------------------------------------------
# X String --- Location to read feature matrix X
# Y String --- Location to read label matrix Y
{code}
Tabs:
{code}
#
# INPUT PARAMETERS:
# ---------------------------------------------------------------------------------------------
# NAME TYPE DEFAULT MEANING
# ---------------------------------------------------------------------------------------------
# X String --- Location to read feature matrix X
# Y String --- Location to read label matrix Y
{code}
However, if I look at how these compare on GitHub, notice that in the Tabs example, the TYPE column and the String values in that column don't line up.
https://gist.github.com/deroneriksson/8cbfe35f6fef01f0c9f31e18654880bd
Even though I've formatted all my Java code for the last 18 years with tabs, since our SystemML code can be viewed on GitHub, I think standardizing to spaces for all files might actually be better.
We could discuss this on the dev list too, which might be a good idea so we can hear opinions from others.
cc [~mwdusenb@us.ibm.com]
was (Author: deron):
Hi [~mboehm7]. If we standardize, I think it may actually be better to use spaces rather than tabs. The reasoning for this is because spaces always render the same in all environments whereas tabs can be unpredictable.
As an example, here are two DML comment blocks, one formatted with spaces and the other formatted with tabs. The formatting looks identical for me in Eclipse:
Spaces:
{code}
#
# INPUT PARAMETERS:
# ---------------------------------------------------------------------------------------------
# NAME TYPE DEFAULT MEANING
# ---------------------------------------------------------------------------------------------
# X String --- Location to read feature matrix X
# Y String --- Location to read label matrix Y
{code}
Tabs:
{code}
#
# INPUT PARAMETERS:
# ---------------------------------------------------------------------------------------------
# NAME TYPE DEFAULT MEANING
# ---------------------------------------------------------------------------------------------
# X String --- Location to read feature matrix X
# Y String --- Location to read label matrix Y
{code}
However, if I look at how these compare on GitHub, notice that in the Tabs example, the TYPE column and the String values in that column don't line up.
https://gist.github.com/deroneriksson/8cbfe35f6fef01f0c9f31e18654880bd
Even though I've formatted all my Java code for the last 18 years with tabs, since our SystemML code can be viewed on GitHub, I think standardizing to spaces for all files might actually be better.
We could discuss this on the dev list too, which might be a good idea so we can hear opinions from others.
[~mwdusenb@us.ibm.com]
> Fix whitespace issues in main algorithms
> ----------------------------------------
>
> Key: SYSTEMML-1406
> URL: https://issues.apache.org/jira/browse/SYSTEMML-1406
> Project: SystemML
> Issue Type: Improvement
> Components: Algorithms
> Reporter: Deron Eriksson
> Assignee: Deron Eriksson
>
> 1) The main algorithms in scripts/algorithms use both spaces and tabs, which can lead to readability issues when looking at the scripts in an environment such as GitHub. See https://github.com/apache/incubator-systemml/tree/master/scripts/algorithms. We should convert tabs to spaces and format accordingly to improve script readability.
> 2) Remove trailing whitespace since git does not like it.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)