Skip to content

Fix docs typos and Fix syntax errors - #911

Open
W0rma wants to merge 14 commits into
Codeception:masterfrom
W0rma:fix-docs-syntax-errors
Open

W0rma wants to merge 14 commits into
Codeception:masterfrom
W0rma:fix-docs-syntax-errors

Conversation

@W0rma

@W0rma W0rma commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

No description provided.

W0rma added 14 commits November 16, 2026 08:41
- add missing semicolon / fix invalid use statement (AdvancedUsage)
- rename duplicate addUser() method (AdvancedUsage)
- close #[Given]/#[Then] attributes and drop duplicated "Given" (BDD)
- remove stray quote in strict locator example (AcceptanceTests)
- add return/property types required by Codeception 5 interfaces and
  base classes (ModulesAndHelpers, Customization, Data)
- use string assertions for strings and fix undefined variable
  (ModulesAndHelpers)
- assertContain -> assertContains (UnitTests)
- grabServiceFromContainer() -> grabService() (Symfony module)
- getModuleNames() -> getCurrentModuleNames() (Extension)
- remove step.before/after.<group> events, which are never dispatched
- step decorators are configured in step_decorators with class names
- Db module: repopulate -> populate
- SOAP module: response -> xmlResponse
- seeEmailIsSent() takes no recipient/subject arguments
- module part must be a key, not a list item (Data)
- fix indentation of Phalcon5/Phalcon4 module options (FunctionalTests, for/phalcon)
- step_decorators is a top-level suite key (for/phalcon)
- modules.config must be a map keyed by module name (for/laravel)
- drop no-op 'config: - Yii2' entry (for/yii)
Codeception 5.3 requires PHP ^8.2.
quickstart:
- FirstCest example matches what Codeception 5 generates

Configuration reference:
- 'reporters' is no longer supported
- remove 'lint' and 'log_incomplete_skipped', which have no effect
- colors defaults to true on every OS; shuffle defaults to false
- document support_namespace, suite-level shuffle and step_decorators
- suite_namespace is computed and cannot be configured
- suite dist config is <SuiteName>.suite.dist.yml
- use Codeception 5 helper namespace
- link to non-numbered guide pages so anchors are kept

ContinuousIntegration:
- JUnit report is report.xml
- GitHub Actions: define PHP version (matrix was undefined and rendered
  empty by Liquid), checkout@v4, drop deprecated --no-suggest
- GitLab: use a PHP 8.4 image
- remove outdated Travis CI section

ParallelExecution:
- fix image paths
- write XML results to the path the merge step reads from
The suite setting error_level always defaults to 'E_ALL & ~E_DEPRECATED',
which overrides the PHP-version-dependent fallback in ErrorHandler, so the
PHP < 8.4 note was misleading. Instead, hint that E_STRICT is deprecated
as of PHP 8.4.
- GettingStarted: --steps output uses the actual test name
- AdvancedUsage: 2 environments run tests 2 times; SignUpCest uses
  AcceptanceTester so it belongs to Tests\Acceptance; @example is an
  annotation and the Cest example uses the #[DataProvider] attribute;
  remove stray backtick
- Customization: the configured directory is output, not log
- Data: link seeInDatabase to its own anchor; snapshot class lives in
  Tests\Support\Snapshot
- link to the non-numbered ModulesAndHelpers page with the correct anchor
- Laravel5 module is now called Laravel; link current Laravel factory docs
- fzaninotto/Faker is archived; link FakerPHP/Faker
- Symfony module looks for App\Kernel in src/ by default, not AppKernel in app/
- for/symfony: front matter must come first, otherwise Jekyll does not
  process the page
- actors and helpers are generated in the Support / Support\Helper namespaces
- link to the multi-application meta-config section
- test.before/after are triggered for all tests, including PHPUnit TestCases
- tests/_bootstrap.php no longer exists; refer to bootstrap files
- group objects live in Tests\Support\Group and are generated with
  generate:groupobject
- generated actions are stored in tests/Support/_generated
- Db::$dbh is deprecated and PDO has no close()/open(); use _getDbh()
- WebDriver module is built on php-webdriver/webdriver; fix RemoteWebDriver
  namespace
- link to non-numbered guide pages so anchors are kept
The generated Cest is final, uses strict types and void return types and
has no _after method.
- AdvancedUsage: sample run output from Codeception 5 instead of 2.4.5
- APITesting: drop module-rest 1.4.1 note, Symfony2 -> Symfony,
  assertRegExp -> assertMatchesRegularExpression
- Codecoverage: Xdebug 3 uses xdebug.mode=coverage instead of
  remote_enable; phpdbg is only supported with PHPUnit 9; replace
  'whitelisted' wording
- UnitTests: link current PHPUnit assertions docs
c3 selects the driver via php-code-coverage's Selector, which supports
pcov and Xdebug for line coverage; path coverage requires Xdebug.
@W0rma
W0rma marked this pull request as ready for review November 16, 2026 08:20
@W0rma
W0rma requested review from Arhell and TavoNiievez November 16, 2026 08:20

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant