From 63c6b62ba73e27bfd3913da454f435057468fa92 Mon Sep 17 00:00:00 2001 From: Jennifer Shehane Date: Tue, 13 Jun 2017 14:05:10 -0400 Subject: [PATCH] comment out unfinished documentation --- .../writing-your-first-test.md | 26 +++++++++++-------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/docs/source/guides/getting-started/writing-your-first-test.md b/docs/source/guides/getting-started/writing-your-first-test.md index a4ffc8d6c8..9690d4f27b 100644 --- a/docs/source/guides/getting-started/writing-your-first-test.md +++ b/docs/source/guides/getting-started/writing-your-first-test.md @@ -9,15 +9,15 @@ title: Writing Your First Test - Basic web navigation, DOM selection, and assertions {% endnote %} -# Visual Learners + -## Organizing Tests with `describe`, `context`, and `it` +# Organizing Tests with `describe`, `context`, and `it` -Cypress uses the nested, functional style of organizing tests made popular by the RSpec, Jasmine, and Mocha communities. (In fact, Cypress bundles and improves on Mocha to provide this support.) It looks like this: +Cypress uses the nested, functional style of organizing tests made popular by the {% url 'RSpec' http://rspec.info/ %}, {% url 'Jasmine' https://jasmine.github.io/ %}, and {% url 'Mocha' https://mochajs.org/ %} communities. (In fact, Cypress {% url 'bundles and improves on Mocha' bundled-tools#Mocha %} to provide this support.) It looks like this: ```js describe('The Pricing Page', function() { @@ -26,20 +26,24 @@ describe('The Pricing Page', function() { }) context('buttons', function() { - it('have the label "buy this"', function() { + it('has the label "buy this"', function() { // test code... }) }) }) ``` -Notice the clean, hierarchical flow of our tests when written in this way. You can nest as many `describe` and `context` blocks under the top-level `describe` as you wish (`describe` and `context` are aliases for each other, use whichever you prefer.) Tests will be defined inside the `it` blocks, and get run sequentially. +Notice the clean, hierarchical flow of our tests when written in this way. You can nest as many `describe` and `context` blocks under the top-level `describe` as you wish -When we load up this file inside Cypress, we can see the hierarchy clearly: +> `describe` and `context` are aliases for each other, use whichever you prefer! -Cypress has also noticed that these tests are empty, and marked them "pending". Let's implement them now! +Tests will be defined inside `it` blocks, and get run sequentially. -## Interacting with the Page + + + + +