search

exercism / legacy-docs

Other
84 stars 55 forks source link

Update exercise README default template #135

Closed Teo-ShaoWei closed 3 years ago

Teo-ShaoWei commented 4 years ago

The improvement to the template ensure that the generated README have consistent single newline in the event of missing .Hints, .TrackInsert, and/or .Spec.Credits.

petertseng commented 4 years ago

It is good to update documentation to indicate a better way!

Shouldn't the actual file be updated in addition? We wouldn't want the documentation to not match the actual file, since then the documentation would say untrue things, defeating the purpose of having it. I didn't see a pull request to https://github.com/exercism/request-new-language-track/pulls yet to update the actual file.

If the complaint is that "it's too hard to keep the documentation in sync with the actual file", then perhaps the code section should be replaced with a link to the file? Then there is no way the two would go out of sync?

Teo-ShaoWei commented 4 years ago

Ah thanks for linking me up to the right place to update. I will do that accordingly. If I miss any other place which I should also update please inform me again!

Teo-ShaoWei commented 4 years ago

This PR is dependent on https://github.com/exercism/request-new-language-track/pull/60.