Commit 28e0e5af authored by Kolja Lucht's avatar Kolja Lucht

Improve wording of e.g and i.e. instances

parent b07515ab
...@@ -147,7 +147,7 @@ as well as these: ...@@ -147,7 +147,7 @@ as well as these:
| Variable | Description | | Variable | Description |
|-|-| |-|-|
| `QA_SCENARIO` | The scenario to run (default `Test::Instance::Image`) | | `QA_SCENARIO` | The scenario to run (default `Test::Instance::Image`) |
| `QA_TESTS` | The test(s) to run (no default, which means run all the tests in the scenario). Use file paths as you would when running tests via RSpec, e.g., `qa/specs/features/ee/browser_ui` would include all the `EE` UI tests. | | `QA_TESTS` | The test(s) to run (no default, which means run all the tests in the scenario). Use file paths as you would when running tests via RSpec, for example, `qa/specs/features/ee/browser_ui` would include all the `EE` UI tests. |
| `QA_RSPEC_TAGS` | The RSpec tags to add (no default) | | `QA_RSPEC_TAGS` | The RSpec tags to add (no default) |
For now [manual jobs with custom variables don't use the same variable For now [manual jobs with custom variables don't use the same variable
......
...@@ -14,7 +14,7 @@ This document describes the conventions used at GitLab for writing End-to-end (E ...@@ -14,7 +14,7 @@ This document describes the conventions used at GitLab for writing End-to-end (E
When clicking in a single link to navigate, use `click_`. When clicking in a single link to navigate, use `click_`.
E.g.: For example:
```ruby ```ruby
def click_ci_cd_pipelines def click_ci_cd_pipelines
...@@ -33,7 +33,7 @@ From a testing perspective, if we want to check that clicking a link, or a butto ...@@ -33,7 +33,7 @@ From a testing perspective, if we want to check that clicking a link, or a butto
When interacting with multiple elements to go to a page, use `go_to_`. When interacting with multiple elements to go to a page, use `go_to_`.
E.g.: For example:
```ruby ```ruby
def go_to_operations_environments def go_to_operations_environments
...@@ -63,12 +63,12 @@ We follow a simple formula roughly based on Hungarian notation. ...@@ -63,12 +63,12 @@ We follow a simple formula roughly based on Hungarian notation.
- `type`: A generic control on the page that can be seen by a user. - `type`: A generic control on the page that can be seen by a user.
- `_button` - `_button`
- `_checkbox` - `_checkbox`
- `_container`: an element that includes other elements, but doesn't present visible content itself. E.g., an element that has a third-party editor inside it, but which isn't the editor itself and so doesn't include the editor's content. - `_container`: an element that includes other elements, but doesn't present visible content itself. For example, an element that has a third-party editor inside it, but which isn't the editor itself and so doesn't include the editor's content.
- `_content`: any element that contains text, images, or any other content displayed to the user. - `_content`: any element that contains text, images, or any other content displayed to the user.
- `_dropdown` - `_dropdown`
- `_field`: a text input element. - `_field`: a text input element.
- `_link` - `_link`
- `_modal`: a popup modal dialog, e.g., a confirmation prompt. - `_modal`: a popup modal dialog, for example, a confirmation prompt.
- `_placeholder`: a temporary element that appears while content is loading. For example, the elements that are displayed instead of discussions while the discussions are being fetched. - `_placeholder`: a temporary element that appears while content is loading. For example, the elements that are displayed instead of discussions while the discussions are being fetched.
- `_radio` - `_radio`
- `_tab` - `_tab`
...@@ -116,7 +116,7 @@ we use the name of the page object in [snake_case](https://en.wikipedia.org/wiki ...@@ -116,7 +116,7 @@ we use the name of the page object in [snake_case](https://en.wikipedia.org/wiki
(all lowercase, with words separated by an underscore). See good and bad examples below. (all lowercase, with words separated by an underscore). See good and bad examples below.
While we prefer to follow the standard in most cases, it is also acceptable to While we prefer to follow the standard in most cases, it is also acceptable to
use common abbreviations (e.g., `mr`) or other alternatives, as long as use common abbreviations (for example, `mr`) or other alternatives, as long as
the name is not ambiguous. This can include appending `_page` if it helps to the name is not ambiguous. This can include appending `_page` if it helps to
avoid confusion or make the code more readable. For example, if a page object is avoid confusion or make the code more readable. For example, if a page object is
named `New`, it could be confusing to name the block argument `new` because that named `New`, it could be confusing to name the block argument `new` because that
......
...@@ -38,7 +38,7 @@ ensures proper isolation. ...@@ -38,7 +38,7 @@ ensures proper isolation.
## Testing an `ActiveRecord::Migration` class ## Testing an `ActiveRecord::Migration` class
To test an `ActiveRecord::Migration` class (i.e., a To test an `ActiveRecord::Migration` class (for example, a
regular migration `db/migrate` or a post-migration `db/post_migrate`), you regular migration `db/migrate` or a post-migration `db/post_migrate`), you
must load the migration file by using the `require_migration!` helper must load the migration file by using the `require_migration!` helper
method because it is not autoloaded by Rails. method because it is not autoloaded by Rails.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment