MDL-65522 block_social_activities: Improve behat steps documentation

The documentation for these steps was not helpful in the Acceptance
testing admin tool page.
This commit is contained in:
Neill Magill 2019-05-07 11:04:48 +01:00
parent 9528b1ff5b
commit b3a0f15444

View File

@ -56,7 +56,11 @@ class behat_block_social_activities extends behat_base {
}
/**
* Checks that the specified activity's action menu contains an item.
* Checks that the specified activity in the social activities block should have the specified editing icon.
*
* This includes items in the action menu for the item (does not require it to be open)
*
* You should be in the course page with editing mode turned on.
*
* @Then /^"(?P<activity_name_string>(?:[^"]|\\")*)" activity in social activities block should have "(?P<icon_name_string>(?:[^"]|\\")*)" editing icon$/
* @param string $activityname
@ -71,7 +75,11 @@ class behat_block_social_activities extends behat_base {
}
/**
* Checks that the specified activity's action menu contains an item.
* Checks that the specified activity in the social activities block should not have the specified editing icon.
*
* This includes items in the action menu for the item (does not require it to be open)
*
* You should be in the course page with editing mode turned on.
*
* @Then /^"(?P<activity_name_string>(?:[^"]|\\")*)" activity in social activities block should not have "(?P<icon_name_string>(?:[^"]|\\")*)" editing icon$/
* @param string $activityname
@ -103,7 +111,7 @@ class behat_block_social_activities extends behat_base {
}
/**
* Clicks on the specified element inside the activity container.
* Finds the element containing a specific activity in the social activity block.
*
* @throws ElementNotFoundException
* @param string $element
@ -119,7 +127,7 @@ class behat_block_social_activities extends behat_base {
}
/**
* Checks that the specified activity is hidden.
* Checks that the specified activity is hidden in the social activities block.
*
* @Then /^"(?P<activity_name_string>(?:[^"]|\\")*)" activity in social activities block should be hidden$/
* @param string $activityname
@ -129,7 +137,7 @@ class behat_block_social_activities extends behat_base {
}
/**
* Checks that the specified activity is hidden.
* Checks that the specified activity is hidden in the social activities block.
*
* @Then /^"(?P<activity_name_string>(?:[^"]|\\")*)" activity in social activities block should be available but hidden from course page$/
* @param string $activityname
@ -139,7 +147,7 @@ class behat_block_social_activities extends behat_base {
}
/**
* Opens an activity actions menu if it is not already opened.
* Opens an activity actions menu in the social activities block if it is not already opened.
*
* @Given /^I open "(?P<activity_name_string>(?:[^"]|\\")*)" actions menu in social activities block$/
* @throws DriverException The step is not available when Javascript is disabled