Skip to content

Update and reformat all READMEs - #950

Merged
N-Parsons merged 5 commits into
exercism:masterfrom
N-Parsons:reformat-readmes
Oct 25, 2017
Merged

Update and reformat all READMEs#950
N-Parsons merged 5 commits into
exercism:masterfrom
N-Parsons:reformat-readmes

Conversation

@N-Parsons

@N-ParsonsN-Parsons commented Oct 18, 2017•
edited
Loading

Copy link
Copy Markdown
Contributor

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.

ilya-khadykin
ilya-khadykin approved these changes Oct 19, 2017
View reviewed changes

@ilya-khadykinilya-khadykin left a comment

Copy link
Copy Markdown
Contributor

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

ilya-khadykin commented Oct 19, 2017

Copy link
Copy Markdown
Contributor

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

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

N-Parsons commented Oct 19, 2017

Copy link
Copy Markdown
ContributorAuthor

@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

ilya-khadykin commented Oct 19, 2017

Copy link
Copy Markdown
Contributor

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

Nathan Parsons added 2 commits October 21, 2017 22:47
Nathan Parsons
Regenerate READMEs using configlet
02379fe
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
Nathan Parsons
two-fer: Remove Test-Driven Development section
df56fe8
@N-ParsonsN-Parsons changed the title [WIP] Move 'Submitting Exercises' to heading level 2Update and reformat all READMEsOct 21, 2017
@N-Parsons

N-Parsons commented Oct 21, 2017

Copy link
Copy Markdown
ContributorAuthor

@M-a-Ge, I think it's finished now!

@cmccandlesscmccandless mentioned this pull request Oct 24, 2017
Merged
@N-ParsonsN-Parsons mentioned this pull request Oct 24, 2017
Merged
3 tasks
@ilya-khadykin

ilya-khadykin commented Oct 25, 2017•
edited
Loading

Copy link
Copy Markdown
Contributor

@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:masterOct 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
@ackerleytng
Move Submitting Exercises to level 2
095b711
(as per exercism#950)
This was referenced Oct 30, 2017
Merged
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@ilya-khadykinilya-khadykinilya-khadykin approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@N-Parsons@ilya-khadykin