Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Fixture docs - possible point of confusion #3592
Very minor gripe here, but I lost some time over it and I wanted to give feedback :)
I got very confused in this page.
If you don't know anything about the smtp module, example reads as if you have to call a method on "smtp" that matches your test name (minus test_).
When looking at an example, a key thing that helps is if you can quickly discover what is arbitrary, and what "has to match something else".
When writing examples, I try to make arbitrary names look arbitrary by munging them in some way or making them look frivolous.
Eg, is smtp here an arbitrary name, or is it something special? smtp is a general protocol, so it's strange to use it as a variable name. It's also almost a module name. Protocols don't tend to "do things",
I would do something like this.
Thanks for the feedback, we appreciate it.
I agree we could use another name for the fixture. How about
Perhaps you would like to contribute a PR with that change?