Skip to content

Commit c3b24a8

Browse files
Pierre-Luc GagnéCopilot
andcommitted
docs: update references to use ds_mysql.hpp umbrella header
- README.md Quick Start: replace 4 individual includes with #include "ds_mysql.hpp" - docs/QUICKREF.md Key Headers: add ds_mysql.hpp as first entry with 'Umbrella header' description - docs/DEVELOPMENT.md: update new-header guidance to reference the three top-level headers that feed the umbrella; update example snippet to use #include "ds_mysql.hpp" Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent d1a09ec commit c3b24a8

3 files changed

Lines changed: 5 additions & 7 deletions

File tree

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,7 @@ DSMySQL provides a **header-only** library for building type-safe SQL queries an
1818
## Quick Start
1919

2020
```cpp
21-
#include "ds_mysql/mysql_database.hpp"
22-
#include "ds_mysql/sql.hpp"
23-
#include "ds_mysql/column_field.hpp"
24-
#include "ds_mysql/varchar_field.hpp"
21+
#include "ds_mysql.hpp"
2522

2623
using namespace ds_mysql;
2724

docs/DEVELOPMENT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ DSMySQL is a header-only library. All functionality lives in `lib/include/ds_mys
2727
1. Create a new header under `lib/include/ds_mysql/`
2828
2. Use `#pragma once`
2929
3. Put all code in the `ds_mysql` namespace
30-
4. Include it transitively through `ds_mysql/sql.hpp` or `ds_mysql/mysql_database.hpp` if appropriate
30+
4. Include it transitively through `ds_mysql/mysql_database.hpp`, `ds_mysql/mysql_metadata.hpp`, or `ds_mysql/sql_extension.hpp` if appropriate (those three are pulled in by the `ds_mysql.hpp` umbrella header)
3131

3232
## Adding Unit Tests
3333

@@ -37,7 +37,7 @@ DSMySQL is a header-only library. All functionality lives in `lib/include/ds_mys
3737

3838
```cpp
3939
#include <boost/ut.hpp>
40-
#include "ds_mysql/sql.hpp"
40+
#include "ds_mysql.hpp"
4141

4242
using namespace boost::ut;
4343
using namespace ds_mysql;

docs/QUICKREF.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,13 @@ DSMySQL/
4141

4242
| Header | Purpose |
4343
|--------|---------|
44+
| `ds_mysql.hpp` | **Umbrella header** — include this to get everything |
4445
| `ds_mysql/mysql_database.hpp` | MySQL connection & queries |
4546
| `ds_mysql/sql.hpp` | SQL query builder |
4647
| `ds_mysql/sql_extension.hpp` | MySQL-specific extensions |
48+
| `ds_mysql/mysql_metadata.hpp` | MySQL information_schema types |
4749
| `ds_mysql/column_field.hpp` | Typed column descriptors |
4850
| `ds_mysql/schema_generator.hpp` | Schema generation |
49-
| `ds_mysql/mysql_metadata.hpp` | MySQL information_schema types |
5051
| `ds_mysql/mysql_config.hpp` | Connection configuration |
5152
| `ds_mysql/varchar_field.hpp` | Fixed-length string type |
5253

0 commit comments

Comments
 (0)