ENH: Miscellaneous fixes in introduction and installation #139
Conversation
|
The choice of 2016 as the first year for the table was somewhat arbitrary (first year for the deprecation cycle of GCC 4.2). |
jhlegarreta
force-pushed
the
MiscellaneousFixesInIntroductionAndInstallation
branch
from
80430f7
to
4b0014f
Compare
jhlegarreta
force-pushed
the
MiscellaneousFixesInIntroductionAndInstallation
branch
from
4b0014f
to
94e1127
Compare
|
Circle CI failures seem unrelated to the patch set: However, before ITK 5.1 is released, maybe these should be fixed: |
|
We might only need to reduce the column limit here: |
Thanks for having a look @dzenanz. I do not remember if that is the flag that applies to documentation pieces that are stripped from the code to populate the SW Guide or whether it applies to the code itself that is stripped for the SW Guide. According to the link in this comment, LaTeX complains when the line length exceeds 80 characters. Other PRs in the history have also been motivated by the same limit.
In that case I guess it is not that important then. The warnings can be fixed at any time. |
|
That should apply to the code itself that is stripped for the SW Guide. |
I guess the choice was justified and has worked well I think, so I see no reason to change it. Should I be wrong, please go ahead and change it. |
|
@hjmjohnson how did you come up with number 88 in InsightSoftwareConsortium/ITK@e18315f? Was it guesstimate or some other method? @jhlegarreta But if other things were updated (LaTeX version or other settings), then we might need to reduce clang-format column limit to avoid LaTeX overflows. After fixing things in ITK we will also need to update ITK's hash in ITKSoftwareGuide. |
I have no for/against argument. I do not see that the LaTeX file contents themselves will be affected. As said, if it needs to be done, please go ahead and update the ITK hash in the SW Guide. |
|
@dzenanz 88 is the optimal result from analyzing millions of lines of python code by the There is also evidence that more than 100 characters can cause troubles for people with vision problems, so I would have a small preference to keep it less than 100 characters. |
|
@hjmjohnson suggestion was to reduce it from 88 to 80, 78 or maybe 79, because the warnings occur at column 80. |
|
OK, but I find that with ITK’s long names we can end up many lines per statement. If this is only with the software guide code I am even more OK with it.
Hans
From: "notifications@github.com" <notifications@github.com>
Reply-To: InsightSoftwareConsortium/ITKSoftwareGuide <reply@reply.github.com>
Date: Wednesday, May 13, 2020 at 10:33 AM
To: InsightSoftwareConsortium/ITKSoftwareGuide <ITKSoftwareGuide@noreply.github.com>
Cc: Hans Johnson <hans.j.johnson@gmail.com>, Mention <mention@noreply.github.com>
Subject: Re: [InsightSoftwareConsortium/ITKSoftwareGuide] ENH: Miscellaneous fixes in introduction and installation (#139)
@hjmjohnson suggestion was to reduce it from 88 to 80, 78 or maybe 79, because the warnings occur at column 80.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or unsubscribe.
|
|
Yes, this is primarily for the software guide, but it will affect all code in the examples directory. |
Being tracked in issue #131. |
|
Rebasing on |
thewtex
force-pushed
the
MiscellaneousFixesInIntroductionAndInstallation
branch
from
94e1127
to
e3698d3
Compare
Miscellaneus fixes in the `Introduction` and `Installation` chapters: - Fix the development environment names. - Rework the compiler list: update to currently supported versions. - Remove the compiler support/deprecation cycle table due to difficulties in keeping it up to date. - Remove the deprecated reference to the Wiki Examples: examples are entirely hosted in https://itk.org/ITKExamples/ since a series of PRs including InsightSoftwareConsortium/ITKSphinxExamples#108 and InsightSoftwareConsortium/ITKSphinxExamples#109. - Update the `vxl` link. - Fix the `Utilities` and `Wrapping` parent folders. - Mention the raw binary files and the SHA512 hash files in the `Testing` folder paragraph. - Take advantage of the commit to order alphabetically the ITK's main folders. Take advantage of the commit for other minor style changes (e.g. period at the end of sentences, proper LaTex quote syntax, etc.). Take advantage of the commit to limit the line length to 79 characters in the ITK's folder structure bullet points.
jhlegarreta
force-pushed
the
MiscellaneousFixesInIntroductionAndInstallation
branch
from
e3698d3
to
a5f9673
Compare
There was a problem hiding this comment.
🥇 thanks @jhlegarreta ! Wonderful to have these updates for 5.1.0.
Miscellaneus fixes in the
IntroductionandInstallationchapters:in keeping it up to date.
entirely hosted in https://itk.org/ITKExamples/ since a series of PRs
including
First batch of updates for Mediawiki-sphinx conversions ITKSphinxExamples#108 and
Media wiki migration second set ITKSphinxExamples#109.
vxllink.UtilitiesandWrappingparent folders.Testingfolder paragraph.
folders.
Take advantage of the commit for other minor style changes (e.g. period at
the end of sentences, proper LaTex quote syntax, etc.).
Take advantage of the commit to limit the line length to 79 characters in
the ITK's folder structure bullet points.