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

Fix list formatting in README #411

Merged
merged 3 commits into from
Oct 2, 2023

Conversation

Scorpil
Copy link
Contributor

@Scorpil Scorpil commented Oct 1, 2023

If you check "Problems Hamilton Solves" section on current master you'll see that the list-like content is rendered on a single line. This PR fixes it.

Changes

Adding two trailing whitespaces to force newline break

Linter is not happy about trailing whitespaces (even though it's a valid Markdown feature), so I replaced them with <br/>

How I tested this

Preview

Notes

First PR where trailing whitespace is a solution and not a problem 😅

Nope, still a problem

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

@elijahbenizzy elijahbenizzy self-requested a review October 1, 2023 17:57
Copy link
Collaborator

@elijahbenizzy elijahbenizzy left a comment

Choose a reason for hiding this comment

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

Great, thanks! Alternatively, we could change the linting rules to allow trailng whitespace in markdown. That said, I think this is fine and looks quite nice.

README.md Outdated Show resolved Hide resolved
youir -> your
@skrawcz skrawcz merged commit 95e7e66 into DAGWorks-Inc:main Oct 2, 2023
18 of 20 checks passed
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.

3 participants