Enhance Behat writing documentation with specific examples #1433
Conversation
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the Behat writing documentation by adding comprehensive examples for common testing scenarios. The additions provide practical guidance for developers writing Behat tests in Moodle environments.
- Added documentation for configuration settings, autocomplete testing, language pack setup, and version-specific tests
- Included code examples with Gherkin syntax for each new section
- Provided specific implementation details for testing various Moodle features
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| #### Configuration settings | ||
|
|
||
| For some tests you may need special configurations be present in you Moodle. These can be set as follows: |
There was a problem hiding this comment.
There's a grammatical error in this sentence. It should be 'configurations to be present in your Moodle' instead of 'configurations be present in you Moodle'.
| For some tests you may need special configurations be present in you Moodle. These can be set as follows: | |
| For some tests you may need special configurations to be present in your Moodle. These can be set as follows: |
Copilot uses AI. Check for mistakes.
|
|
||
| #### Autocomplete options | ||
|
|
||
| To test that autocomplete options appear in a list as you type (such as the course search), a test can be witten |
There was a problem hiding this comment.
The word 'witten' should be 'written'.
| To test that autocomplete options appear in a list as you type (such as the course search), a test can be witten | |
| To test that autocomplete options appear in a list as you type (such as the course search), a test can be written |
Copilot uses AI. Check for mistakes.
| And the following "language packs" exist: | ||
| | language | | ||
| | fr | | ||
| | de | |
There was a problem hiding this comment.
There's trailing whitespace after the pipe character that should be removed for consistency.
| | de | | |
| | de | |
Copilot uses AI. Check for mistakes.
| | de | | ||
| | es | | ||
| ``` | ||
| This would have the additional language packs for French, German ans Spanish installed on the system. English |
There was a problem hiding this comment.
The word 'ans' should be 'and'.
| This would have the additional language packs for French, German ans Spanish installed on the system. English | |
| This would have the additional language packs for French, German and Spanish installed on the system. English |
Copilot uses AI. Check for mistakes.
| This would have the additional language packs for French, German ans Spanish installed on the system. English | ||
| is still present as well. | ||
|
|
||
| With the following test stepts the user may change the language: |
There was a problem hiding this comment.
The word 'stepts' should be 'steps'.
| With the following test stepts the user may change the language: | |
| With the following test steps the user may change the language: |
Copilot uses AI. Check for mistakes.
|
|
||
| #### Moodle version | ||
|
|
||
| Sometimes it's neccessary that a behat tests runs on a certain version of Moodle only. |
There was a problem hiding this comment.
The word 'neccessary' should be 'necessary', and 'behat tests' should be 'Behat test' (singular) to match the context.
| Sometimes it's neccessary that a behat tests runs on a certain version of Moodle only. | |
| Sometimes it's necessary that a Behat test runs on a certain version of Moodle only. |
Copilot uses AI. Check for mistakes.
The additions provide practical guidance for developers writing Behat tests in Moodle environments. * Added documentation for configuration settings, autocomplete testing, language pack setup, and version-specific tests * Included code examples with Gherkin syntax for each new section * Provided specific implementation details for testing various Moodle features
Added examples on configuration settings, autocomplete options, language packs, and Moodle version requirements for Behat tests.