search

busterjs / buster

Abandoned - A powerful suite of automated test tools for JavaScript.
http://docs.busterjs.org
Other
448 stars 37 forks source link

Documentation on BDD style testing #385

Closed fatso83 closed 9 years ago

fatso83 commented 10 years ago

There seems to be missing easy to find documentation for BDD style testing on the BusterJS homepage. Basically, all there needs to be for this to be amended is a link to http://docs.busterjs.org/en/latest/modules/buster-assertions/#expectations.

dwittner commented 10 years ago

@fatso83, on the start page of the documentation we have a link BDD syntax in the User’s guide section. There you can find an example for the use of specs/examples (but not for expectations) and a link to Test spec for further informations. Would it help to add the link to Expectations there?

fatso83 commented 10 years ago

:+1: to that.

After seeing your comment I immediately headed to the start page and user guide and could not find what I was looking for. Because what I was actually searching for were the "assertions", or expectations, as you rightfully call them. I then returned to your post and read the last sentence ... (note to self: read entire comment before acting)

So YES: adding a link to the expectations would definitely help, as there is no clear way on how to find them. You have to take into account that people such as myself do not know the right vocabulary (such as "Expectations" for expect(...).toBe(true) style testing), but can often recognize a code snippet to be the right thing. So having a link to the list of expectations in the places they are used in the documentation would definitely help!

dwittner commented 9 years ago

Link added: https://github.com/busterjs/buster-docs/commit/f384d825a085cb0c9819fc422702d98e5f859710