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

Improve documentation #49

Merged
merged 13 commits into from
Jul 25, 2024
Merged

Conversation

jfmengels
Copy link
Contributor

Hi there 👋
I found a bunch of places where documentation could be improved.

  • Some of the documentation was indented and was therefore presented as a code block
  • Some of the code blocks were really long, and therefore you had to horizontally scroll to see the contents (it's still there now but it's a lot better)
  • Changed the way ClauseInCase was presented to tell more like a story. This can be done for plenty of others as well I think.
  • Applied elm-format to some of the files
  • Fixed a few typos or errors, and did some tiny bit of cleanup of the code.

Let me know if you'd like this to be split into several PRs.

@jxxcarlson jxxcarlson merged commit 9214712 into jxxcarlson:main Jul 25, 2024
2 checks passed
jxxcarlson added a commit that referenced this pull request Jul 25, 2024
@jfmengels jfmengels deleted the doc-improvements branch July 25, 2024 11:43
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.

2 participants