Skip to content
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

Remove markdown linting warnings - see #117 #123

Merged
merged 4 commits into from
Oct 10, 2022

Conversation

jcohen02
Copy link
Contributor

@jcohen02 jcohen02 commented Oct 4, 2022

This PR removes a number of linter warnings relating to line length on markdown files, as detailed in #117.

In addition to the line length issues, a few other Markdown formatting changes have been made to address warnings raised when running markdownlint on files locally (e.g. trailing spaces, multiple blank lines, ...).

Opening the PR to check that the changes are indeed resolving the warnings - currently a small group of files have been updated, the remainder will be updated in the coming days and additional commits with further changes pushed to this PR.

Closes #117

(Contributing to Hacktoberfest! - please add hacktoberfest-accepted tag as and when PR is accepted and merged 🎉 )

@bencomp
Copy link
Contributor

bencomp commented Oct 7, 2022

Thanks for your contribution, @jcohen02! This looks good so far.

As you mention you intend to add more commits to fix the other files, I'll keep this open for now and approve when the other files are ready. (If you don't have time for more, no worries! I could just remove the "closes issue" link and merge.)
I assume #124 comes from checking your changes, which is very helpful :)

@jcohen02
Copy link
Contributor Author

jcohen02 commented Oct 8, 2022

Thanks for your contribution, @jcohen02! This looks good so far.
As you mention you intend to add more commits to fix the other files, I'll keep this open for now and approve when the other files are ready.

No problem @bencomp, happy to help. I think this should now be done, if you could approve the running of the GHA workflow, the previous line length errors are now hopefully resolved.

I assume #124 comes from checking your changes, which is very helpful :)

Yes, indeed, I've tried to check the rendered site locally as I've been going along with the changes to see that nothing has broken the formatting in the lesson content. I think this all looks OK but would welcome someone more familiar with the lesson content giving this a quick check through when reviewing.

Copy link
Contributor

@bencomp bencomp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your work! It renders correctly, even with the whitespace inside the Markdown links.


![History](../fig/history.png)
![History](../fig/history.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, this seems to fix an issue mentioned in #95 (which was closed already, without providing a fix...)

@bencomp bencomp merged commit e19936a into datacarpentry:gh-pages Oct 10, 2022
zkamvar pushed a commit that referenced this pull request Apr 28, 2023
Remove markdown linting warnings - see #117
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lines in markdown files are too long, discuss.md is missing
2 participants