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

pangram: clarify language in README #802

Closed
wants to merge 1 commit into from
Closed

pangram: clarify language in README #802

wants to merge 1 commit into from

Conversation

tleen
Copy link
Member

@tleen tleen commented Aug 15, 2017

Made README clearer in regards to allowed inputs for pangram / allowed
inputs for interface.

Added the term 'rune' into the problem context.

Resolves #801

Made README clearer in regards to allowed inputs for pangram / allowed
inputs for interface.

Added the term 'rune' into the problem context.

Resolves #801
@robphoenix
Copy link
Contributor

I'm not fully up on generating the READMEs, is this in danger of being overwritten?

@tleen
Copy link
Member Author

tleen commented Aug 15, 2017

I don't think so, I believe that was a one time thing? I do have to look into it more, it's part of the reason why #786 has been sitting around. If that ends up happening we can redo in the local metafile or wherever.

@tleen
Copy link
Member Author

tleen commented Aug 15, 2017

Yes, it would be overwritten but by us via configlet, automation in README's is a thing of the past. See the comment in 4a9e2a0. Full docs here.

@robphoenix
Copy link
Contributor

Okay, yeah, unless we change the description.md in the problem-specifications repo, then anything we add to hints.md will be additional. To change this we need to re-write it here. I suppose we just need to be considerate of this if we ever want to regenerate READMEs in the future and not just do them all.

@tleen
Copy link
Member Author

tleen commented Aug 15, 2017

This may be a good example of why we moved to locally generated READMEs in the first place.

@robphoenix
Copy link
Contributor

I wonder if we're addressing the wrong problem here. Looking at exercism/problem-specifications@ff2abe7 & exercism/problem-specifications#842 it may be that we should update the test suite to reflect the canonical-data.json instead of rewriting the README. And then add a generator when we can.

@tleen
Copy link
Member Author

tleen commented Aug 15, 2017

Yeah, I think that is better since we are the divergent track here.

@tleen tleen closed this Aug 15, 2017
@robphoenix
Copy link
Contributor

Okay, do you want to update the config.json manually now until we implement the generator?

@tleen
Copy link
Member Author

tleen commented Aug 15, 2017

I was gonna yank those two entries out of the test suite?

@robphoenix
Copy link
Contributor

Sounds good 👍

tleen added a commit that referenced this pull request Aug 15, 2017
This brings the tests into consistency with the README.

Resolves #801, also see #802
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