Skip to content
This repository has been archived by the owner on Sep 7, 2018. It is now read-only.

Documentation on BDD style testing #385

Closed
fatso83 opened this issue Oct 25, 2013 · 3 comments
Closed

Documentation on BDD style testing #385

fatso83 opened this issue Oct 25, 2013 · 3 comments

Comments

@fatso83
Copy link

fatso83 commented Oct 25, 2013

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
Copy link
Member

dwittner commented Nov 1, 2013

@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?

@ghost ghost assigned dwittner Nov 1, 2013
@fatso83
Copy link
Author

fatso83 commented Nov 1, 2013

👍 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
Copy link
Member

dwittner commented Nov 1, 2014

Link added: busterjs/buster-docs@f384d82

@dwittner dwittner closed this as completed Nov 1, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants