Codeception / Codeception/module-db

Documentation for 'cleanup' configuration option

Open
#25 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
PHP
Stars
23
Forks
31
PR merge metrics
No merged PRs in 30d

Description

Hi,

seems like the documentation for the 'cleanup' configuration option ist not correct:

cleanup: false - whether the dump should be reloaded before each test

It think more correct would be:

cleanup: false - whether all database tables should be dropped

I am not quite sure if this dropping happens once or before each test.
The docs mention the 'clearing' of the database, but not in connection with this option.

Make this more precise would be great!

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the documentation entry for the `cleanup` configuration option and inspect the module behavior that determines when database tables are dropped or cleared. Confirm whether cleanup happens once or before each test, then update the option description to state the behavior precisely.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.