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 typo in high-score board instructions #752

Merged
merged 4 commits into from
Jun 2, 2024

Conversation

spaenleh
Copy link
Contributor

In this PR I propose to fix a small typo in the high-score board instructions file.

Let me know if you would prefer to group this fix with other fixes. I haven't spotted others so far. I see that #725 is still open, so maybe they can be grouped.

Fix a small typo in the high-score board instructions file.
@meatball133
Copy link
Member

meatball133 commented May 22, 2024

I think it is okay to not group this pr with 725, I will let the contributor get some more time to make the changes I said had to be made.

Meanwhile these changes should also be applied to the following files:

  • concept:dictonary:about.md
  • exercise:high-score-board:introduction.md

Otherwise, the changes look good!

@spaenleh
Copy link
Contributor Author

spaenleh commented Jun 2, 2024

@meatball133 Thank you for your comment, I looked at the files you mentioned but did not see any change needed there. Let me know if I missed some, or if you wanted me to check files related to the same concept.

I used the opportunity to cleanup the concepts:dictionaries:about.md file by removing some dangling code fences and adding a missing code example (copied from another file).

Can you review these changes, or should I wait for another maintainer to comment on the PR ?
Thank you again for your time.

@meatball133
Copy link
Member

meatball133 commented Jun 2, 2024

I took a very and I mean very hasty look at the pr and didnt check the underlying docs. But realized quickly after I took another look rn after your comment that the docs are incorrectly structured (not anything you have done or could have known). The about file should always be longer than the introduction file and often to keep things simple it is often quite good to keep those files rather similiar. Seems like the author of this concept didnt do any of that.

So I will approve your pr and merge it and put this on my list to reorginze the docs.

@meatball133 meatball133 merged commit dbaf1c1 into exercism:main Jun 2, 2024
4 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.

2 participants