Exemplify more Carpentries-relevant code style tools

[katrinleinweber]

Since no Carpentries lesson teaches Perl, Ruby or focusses on HTML, how about mentioning tools that are relevant for our curriculum? These are suggestions which have been mentioned in a lesson, or its repository.

Related to https://github.com/datacarpentry/R-ecology-lesson/issues/359, https://github.com/swcarpentry/shell-novice/issues/239 & https://github.com/swcarpentry/r-novice-gapminder/pull/529, and to #432.

[maxim-belkin]

I'd like to weigh in here.

What I like about this PR

• it refers to the tools that The Carpentries actually teach
• it provides a suggestion how to share information in a project.

Where it could be improved

• "Code -> Reformat Code" doesn't do much -- it seems that this is a code beautifier, not style-enforcer, like styleR or pep8 (btw, pep8 is both, a style guide and a tool that was recently renamed to pycodestyle). I think "Code -> Reformat Code" is from a different category of tools so shouldn't be listed.
• linking to Python Novice Gapminder -- Imagine telling a story and saying "...like chickens in modern era, some creatures that you can read about in another book in middle age, and dinosaurs millions of years ago...". (weird example, I know). The point is -- the middle part doesn't make sense. If we're providing examples for R, Python, and Bash -- it only makes sense to do it for every tool. So, I think a specific Python tool (style guide enforcer) has to be listed.
• Links. In general, I think links have to point to the home pages of the linked text. Links to our lessons should be preceded with a text that reads something like this You can learn more about these tools in our lessons on [Python](link), [R](link), and [Bash](link). But this is a separate sentence and the benefits of adding it have to be reviewed.
• change ShellCheck.Net to ShellCheck

So, in summary, my suggestions are:

• remove "Code -> Reformat Code"
• list pycodestyle for Python
• remove links to SWC lessons
• if discussions of these tools in our lessons are significant -- consider adding links to these discussions in a separate sentence.

Great work y'all!

[kekoziar]

Hi, @katrinleinweber. This PR is old, but not stale. Are you able to update your PR taking into account the last two comments?

[kekoziar]

I'm going to close this PR in preparation of the new workbench lesson infrastructure, but with a comment that the content is generally approved, but needed to be updated. I will leave the labels in place so it's easier to find to update.