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

Practice Exercise spec mentions problem-specification introduction file - none exist. #54

Closed
verdammelt opened this issue Feb 12, 2021 · 4 comments

Comments

@verdammelt
Copy link
Member

The practice exercise spec mentions that .docs/introductions.md is required if the problem specification has a introductions.md file. But it does not look like any problem specification exercise has such a file.

It appears in my track that the .docs/introduction.md file was derived from the problem specification exercises' description.md. Should this reference to introduction.md in problem specification be replaced with a reference to description.md?

@verdammelt
Copy link
Member Author

I can put in a PR to fix this if someone can confirm the reference is incorrect.

@verdammelt
Copy link
Member Author

Closing this issue - I believe I was confused between 'introduction' and 'instruction'. I see that instruction file is defined to be derived from the problem specifiation description file.

Sorry for the noise.

@iHiD
Copy link
Member

iHiD commented Feb 12, 2021

@verdammelt Good spot. The aim is to migrate all problem specs from a single description.md file to introduction.md and instructions.md. However, we don't want anything blocked by this, so we're respecting description.md for now, and then also intro/instructions when they're done.

We decided not to rename the description.md to instructions.md as having them with the old name allows us to see which have been migrated over and which haven't.

See also https://github.com/exercism/go/pull/1414/files#r574656719 (which I'd like to discuss on today's call).

If there is somewhere we could update the docs in this repo to make all that i've just written clear(er) or fix bits that don't mention it, I'd appreciate the PR for that! :)

@iHiD
Copy link
Member

iHiD commented Feb 12, 2021

Sorry for the noise.

@verdammelt Not noise! Let's get it clarified better in the docs :)

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

No branches or pull requests

2 participants