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

Testing & Documentation #29

Open
tnugent97 opened this issue Mar 15, 2017 · 1 comment
Open

Testing & Documentation #29

tnugent97 opened this issue Mar 15, 2017 · 1 comment

Comments

@tnugent97
Copy link

Whats the difference between the testing folder and the test_deliverable folder?

Do you want us to write up the documentation straight into the 3-compiler-documentation.md file or a separate file?

What is is the point of the doc folder ?

@m8pple
Copy link
Contributor

m8pple commented Mar 17, 2017

The testing vs test_deliverable is sloppy git on my part - the testing directory I accidentally
transferred in after developing the new directory it in the lecture; I hadn't noticed I managed
to capture it when I uploaded the pre-prepared version. I'll take it out, and add a note.

The documentation can go straight into the 3-compiler-documentation.md file, so
you can directly overwrite that file.

I was imagining the file going into the doc folder, but that isn't made clear. This
part is less well specified simply because I'll have to find and read the thing as
a human, so hadn't thought too much about where exactly things should go.

I'll think a bit more carefully to make sure I'm not going to break things people
have already done, then update the spec to make it more precise.

Thanks for pointing those out.

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