Revert "Decision 8 Documenting quality dimensions"

[BobBorges]

Reverts #31

revert premature merge

[BobBorges]

I removed the prematurely merged documents from main and reintroduce them here. @MansMeg only minor edits to the decision doc -- templates look fine.

[MansMeg]

Can you edit the paragraph where I now say that the template should be included as a header in the unit test files?

[BobBorges]

Can you edit the paragraph where I know say that the template should be included as a header in the unit test files?

So you want it to say what exactly? In python, this would be a docstring, equivalent to a description... you can either import .md, write a docstring, or both... all this ends up in the API documentation.

A short docstring is handy for people who look at the code and not the documentation.

[MansMeg]

Now it says the following:

Each test should be stored as test-[what-is-checked-automatically].py/r. Each test should include a header in comment describing the test and why it has been included. See the data-integrity-test template.

What should it say on how we store the documentation? I guess we should store .md files? Maybe with the name readme-[what-is-checked-automatically].md ?

[BobBorges]

I think the quality estimate can also be stored as test-[some-quality-dimension].py. it's also a kind of test.

[MansMeg]

I think there is a difference, and we make a difference in our paper. I also think there is a qualitative difference between the two.
So, I would try to separate them. Say:
qe-[some-quality-dimension].py or similar.

[MansMeg]

I think it looks really good now!

[BobBorges]

OK, so I changed the status in the document. will merge after @ninpnin's approval.