Turn ignored doctests on Database into real doctests #29
Labels
No labels
area:core
area:database
area:migrations
area:model
area:relations
area:schema
area:tests
breaking-change
size:M
size:S
tracking
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
NoctisWolfshadow/tessera-orm#29
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Problem
The examples on
Database::connect,transaction,executeandexecute_batchinsrc/database/connection.rsare marked```ignore, so rustdoc never compiles them. If the API changes, the docs can silently go stale.Proposal
Replace
ignorewith real doctests. Build the database fromConfig::memory()and hide the setup lines with#, so the rendered docs only show the example itself.Tasks
Database::connectDatabase::transactionDatabase::executeDatabase::execute_batchDone when
cargo test --docruns all four examples with 0 ignored.#setup lines.