Rewrite Python Test Framework docs about docs HOT 14 CLOSED

do we agree to describe only v2? (saying that v1 still exists in old katas should be enough. Only PUs will be facing old codes to maintain anyway, I guess)

I'll begin with the reference manual.

from docs.

BTW, now that we're talking about it... Should we add my module forbidder to the test framework? That would require some work, but it's already in the wild in a lot of katas and it's spreading. And it has some flaws and it already became impossible to update it everywhere, since I don't know all the places... :/

(yeah, it's "a bit" off topic... x) )

from docs.

Yeah, focus on the v2. We can add some notes about the old one later.

For module forbidder, can you open a new issue at https://github.com/codewars/python-test-framework?

from docs.

done

is that repo the last version? (I believe not?) I'd like to have the code on hand so that I can check what I write about it. XD

from docs.

Yeah, it's the version being used on Codewars.

from docs.

👍

from docs.

how do I integrate an picture...? :/

from docs.

#18

This part is complete about the content except for:

• the picture
• the module forbidder

Tho, I forgot about the headers specific to docs.codewars

from docs.

Can you move the files?

• document to content/languages/python/codewars-test-famework/index.md
• image to content/languages/python/codewars-test-framework/python-test-framework-example.png

Then, use the image in the Markdown. ![Python Test Framework Example](./python-test-framework-example.png).

Also, add frontmatter to Markdown so that it shows up on the Python page and navigations are added.

---
category: references
languages: [python]
tags:
  - testing
sidebar: "language:python"
prev: /languages/python/
---

from docs.

Ok, I'll see that tomorrow. I really need to sleep, right now.

cheers

from docs.

On structuring the test suite with describe/it:

Assertions directly in describe should be avoided. It happens to work at the moment, but it's awkward.
Top-level it should be fine. Many test frameworks don't have describe.
Top-level assertions are strongly discouraged.

So describe -> it -> assertions best, it -> assertions ok, describe -> assertions bad, assertions bad.

from docs.

Created an issue dedicated to the guide here: #191.

from docs.

@kazk now #191 and #197 are done, do you consider anything more necessary in scope of this issue, or can it be closed?

from docs.

This can be closed. Thanks everyone, for writing them.

from docs.