Skip to content

Update and reformat all READMEs #950

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

Merged
merged 5 commits into from
Oct 25, 2017

Conversation

N-Parsons
Copy link
Contributor

@N-Parsons N-Parsons commented Oct 18, 2017

I found it weird that the "Submitting Exercises" was at heading level 3 in the README, since this sometimes meant that it appeared to be a subheading of something unrelated.

This PR updates all exercises, as well as the insert used for automated generation of READMEs.

Copy link
Contributor

@ilya-khadykin ilya-khadykin left a comment

Choose a reason for hiding this comment

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

Makes sense to me

@ilya-khadykin
Copy link
Contributor

@N-Parsons did you regenerated it with configlet or use your own tooling?

@N-Parsons N-Parsons changed the title Move 'Submitting Exercises' to heading level 2 [WIP] Move 'Submitting Exercises' to heading level 2 Oct 19, 2017
@N-Parsons
Copy link
Contributor Author

@m-a-ge, I did it with a Python script as a quick solution.

I just took a look with the configlet (it's surprisingly easy to use!) and there are a few minor changes in a lot of the READMEs (removal of white-space, slight rewords, etc.) and 9 need closer work due to significant changes or issues with the upstream problem-specifications. I'm happy to go through and fix them, so I've marked this PR as WIP until I have these resolved - I should have some time this weekend.

@ilya-khadykin
Copy link
Contributor

@N-Parsons thanks a lot for working on this!

Nathan Parsons added 2 commits October 21, 2017 22:47
diffie-hellman: add hints.md and regenerate README

collatz-conjecture: add hints.md and regenerate README

markdown: Remove redundant first line

saddle-points: Remove extraneous 'the'

simple-cipher: suggest returning a ValueError
@N-Parsons N-Parsons changed the title [WIP] Move 'Submitting Exercises' to heading level 2 Update and reformat all READMEs Oct 21, 2017
@N-Parsons
Copy link
Contributor Author

@m-a-ge, I think it's finished now!

@N-Parsons N-Parsons mentioned this pull request Oct 24, 2017
3 tasks
@ilya-khadykin
Copy link
Contributor

ilya-khadykin commented Oct 25, 2017

@N-Parsons fell free to merge it at will

But we'll have to revisit README.md templates at some point

@N-Parsons N-Parsons merged commit cf4f50f into exercism:master Oct 25, 2017
@N-Parsons N-Parsons deleted the reformat-readmes branch October 25, 2017 21:04
ackerleytng added a commit to ackerleytng/python that referenced this pull request Oct 27, 2017
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