Skip to content

Commit a9d00a5

Browse files
committed
chore: Lint Markdown files
1 parent 2bce2b5 commit a9d00a5

File tree

2 files changed

+53
-47
lines changed

2 files changed

+53
-47
lines changed

CHANGELOG.md

Lines changed: 52 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# v2.13.0
1+
# ChangeLog
2+
3+
## v2.13.0
4+
5+
### New Features
26

3-
## New Features
47
- Added support for optional binding to allow out-of-order retrieval of unbound columns with `SQLGetData` [`#236`](https://github.com/nanodbc/nanodbc/pull/236)
58
- Added `catalog::find_table_privileges` method [`#204`](https://github.com/lexicalunit/nanodbc/pull/204)
69
- Added `connection::allocate` method to manage ODBC handles handles [`#147`](https://github.com/lexicalunit/nanodbc/pull/147)
@@ -29,7 +32,8 @@
2932
- Added very minimal support for SQL Server-specific time datatypes [`#228`](https://github.com/lexicalunit/nanodbc/pull/228)
3033
- Allowed binding values of all intrinsic integral types [`#232`](https://github.com/lexicalunit/nanodbc/pull/232)
3134

32-
## Changes
35+
### Changes
36+
3337
- Changed `COLUMN_SIZE` for `bytea` to now equal `SQL_NO_TOTAL(-4)` by default [`#251`](https://github.com/lexicalunit/nanodbc/pull/251)
3438
- Disabled declaration of async methods if `NANODBC_DISABLE_ASYNC` is defined [`#197`](https://github.com/lexicalunit/nanodbc/pull/197)
3539
- Fixed, improved and cleaned up the family of bind functions
@@ -42,7 +46,8 @@
4246
- Report `SQL_HANDLE_DBC` error if statement::open fails to allocate handle [`#178`](https://github.com/lexicalunit/nanodbc/pull/178)
4347
- Started enforcing project-wide consistent code style using `clang-format` [`#203`](https://github.com/lexicalunit/nanodbc/pull/203)
4448

45-
## Bug Fixes
49+
### Bug Fixes
50+
4651
- Added DB-specific tests for `result::affected_rows` [`#154`](https://github.com/lexicalunit/nanodbc/pull/154)
4752
- Fixed `statement_impl::async*` members which were left uninitialized if not built-in [`#187`](https://github.com/lexicalunit/nanodbc/pull/187)
4853
- Fixed binding of `SQL_DECIMAL` and `SQL_NUMERIC` type as character data [`#238`](https://github.com/lexicalunit/nanodbc/pull/238)
@@ -62,7 +67,8 @@
6267
- Resolved unexpected `bind()` with nulls set to `nullptr` behavior [`#140`](https://github.com/lexicalunit/nanodbc/pull/140)
6368
- Updated to catch up with breaking change in SQLite ODBC 0.9996 [`#165`](https://github.com/nanodbc/nanodbc/pull/165)
6469

65-
## Testing
70+
### Testing
71+
6672
- Added `integer_boundary` test case for SQLite [`#174`](https://github.com/lexicalunit/nanodbc/pull/174)
6773
- Added AppVeyor build targeting SQL Server 2016 [`#194`](https://github.com/lexicalunit/nanodbc/pull/194)
6874
- Added CI job to lint and build docs [`#152`](https://github.com/lexicalunit/nanodbc/pull/152)
@@ -79,7 +85,7 @@
7985
- Refactored test fixture and split into common utilities base and test case base [`#225`](https://github.com/lexicalunit/nanodbc/pull/225)
8086
- Updated Catch to 2.4.2 [`#201`](https://github.com/lexicalunit/nanodbc/pull/201)
8187

82-
## Acknowledgements
88+
### Acknowledgements
8389

8490
[Denis Glazachev](https://github.com/traceon),
8591
[Jim Hester](https://github.com/jimhester),
@@ -100,30 +106,30 @@
100106
[ThermoX360](https://github.com/ThermoX360),
101107
[detule](https://github.com/detule)
102108

103-
# v2.12.4
109+
## v2.12.4
104110

105111
Resolves a possible crash with `SQLDescribeParam()`. In Progress OpenEdge 11 driver setting the
106112
nullableptr argument to null causes a crash. This does not affect SQLite or MySQL drivers.
107113

108114
Thanks to [@AndrewJD79](https://github.com/AndrewJD79) for finding and diagnosing the issue!
109115

110-
# v2.12.3
116+
## v2.12.3
111117

112118
Unicode: Resolves a major issue with BLOB datatype handling for BINARY and TEXT columns.
113119

114-
# v2.12.2
120+
## v2.12.2
115121

116122
Resolves a major issue with BLOB datatype handling for BINARY and TEXT columns.
117123

118-
# v2.12.1
124+
## v2.12.1
119125

120126
Resolves a Travis-CI build issue.
121127

122-
# v2.12.0
128+
## v2.12.0
123129

124130
Major work undertaken by Mateusz Łoskot provides new features and a host of bug fixes throughout.
125131
Refactoring work moves nanodbc away from platform dependent `wchar_t` in favor of `char16_t` or in the
126-
case of iODBC with unicode build enabled, `char32_t`. Boost.Test dropped in this version, in favor of Catch.
132+
case of iODBC with Unicode build enabled, `char32_t`. Boost.Test dropped in this version, in favor of Catch.
127133

128134
## New Features
129135

@@ -135,7 +141,7 @@ case of iODBC with unicode build enabled, `char32_t`. Boost.Test dropped in this
135141
## Testing
136142

137143
- Migrates tests from Boost.Test to Catch framework.
138-
- Enables unicode tests on travis-ci.
144+
- Enables Unicode tests on Travis CI.
139145
- Syncs `Dockerfile` and `Vagrantfile`; adds quick usage docs for vagrant.
140146
- Switch Dockerfile over to `ubuntu:precise` (default).
141147
- Improve `odbc_test.cpp` to cope with DBMS variations.
@@ -150,23 +156,23 @@ case of iODBC with unicode build enabled, `char32_t`. Boost.Test dropped in this
150156
- Fix check of total of characters required to display `SQL_DATE`.
151157
- Fix `SELECT` result sorting with `NULL` values involved.
152158

153-
# v2.11.3
159+
## v2.11.3
154160

155161
- Fixes segmentation fault issue with unixODBC on Linux systems.
156162
- Adds support for `while(!results.end())` style iteration.
157163

158-
# v2.11.2
164+
## v2.11.2
159165

160166
- Adds this CHANGELOG.md file. Future releases should update it accordingly!
161167
- Adds CHANGELOG.md helper script.
162168

163-
# v2.11.1
169+
## v2.11.1
164170

165171
## New Features
166172

167173
- Major thanks again to Mateusz Łoskot for all the new features!
168174
- Adds convenient access to catalog objects (tables, columns, primary keys).
169-
- Adds `database_name` and `catalog_name `methods to connection class.
175+
- Adds `database_name` and `catalog_name` methods to connection class.
170176
- Adds CMake option `NANODBC_ENABLE_LIBCXX` to enable/disable libc++ builds.
171177
- Adds CMake option `NANODBC_EXAMPLES` to enable/disable the example target.
172178
- Adds a `latest` release branch to track most recent release.
@@ -177,14 +183,14 @@ case of iODBC with unicode build enabled, `char32_t`. Boost.Test dropped in this
177183
- Adds general `odbc_test` to target variety of ODBC drivers.
178184
- Adds specific MySQL tests.
179185
- Updates test target organization.
180-
- The way the targets were designed is such that:
181-
- test: runs all tests, but will not build them
182-
- tests: builds all tests, but does not run them
183-
- check: builds all tests and then runs all tests
184-
- For individual tests then, it makes sense to use:
185-
- ${name}_test: runs ${name}_test, but will not build it
186-
- ${name}_tests: builds ${name}_test, but does not run it
187-
- ${name}_check: builds ${name}_test and then runs it
186+
- The way the targets were designed is such that:
187+
- test: runs all tests, but will not build them
188+
- tests: builds all tests, but does not run them
189+
- check: builds all tests and then runs all tests
190+
- For individual tests then, it makes sense to use:
191+
- ${name}_test: runs ${name}_test, but will not build it
192+
- ${name}_tests: builds ${name}_test, but does not run it
193+
- ${name}_check: builds ${name}_test and then runs it
188194

189195
## Bug Fixes
190196

@@ -201,7 +207,7 @@ case of iODBC with unicode build enabled, `char32_t`. Boost.Test dropped in this
201207
- Adds examples based on the documentation.
202208
- Adds `rowset_iteration` example.
203209

204-
# v2.10.0
210+
## v2.10.0
205211

206212
## New Features
207213

@@ -216,13 +222,13 @@ case of iODBC with unicode build enabled, `char32_t`. Boost.Test dropped in this
216222
- Refine assert in `result_impl::position` with `SQL_ROW_NUMBER_UNKNOWN`.
217223
- MSBuild Platform property for 32-bit is Win32.
218224
- Reset null indicator before move for all columns, not just bound columns.
219-
- Fixes doxygen generation of macro docs.
225+
- Fixes Doxygen generation of macro docs.
220226

221-
# v2.9.1
227+
## v2.9.1
222228

223229
## New Features
224230

225-
- Adds Vagrantfile to support testing and development.
231+
- Adds `Vagrantfile` to support testing and development.
226232
- Adds customizable `NANODBC_ASSERT` macro.
227233
- Adds CMake option `NANODBC_STATIC` (default OFF).
228234
- Clean up Visual C++ 64-bit warnings.
@@ -243,7 +249,7 @@ case of iODBC with unicode build enabled, `char32_t`. Boost.Test dropped in this
243249
- Updates to SQLite tests.
244250
- Disable MSVC warning C4244 in tests.
245251

246-
# v2.8.1
252+
## v2.8.1
247253

248254
- Update CMakeLists.txt to enable builds with Visual Studio. Thanks Mateusz Łoskot!
249255
- Add async connection support, plus extended database_error info. Thanks Yao Wei Tjong!
@@ -252,56 +258,56 @@ case of iODBC with unicode build enabled, `char32_t`. Boost.Test dropped in this
252258
- Define `NANODBC_SNPRINTF` in terms of `_snprintf_s` for MSVC.
253259
- Setting CMake `-DNANODBC_ODBC_VERSION` option now works.
254260

255-
# v2.7.0
261+
## v2.7.0
256262

257263
- Adds move constructors.
258264
- Fixes Xcode MARK comments.
259265
- Adds section comment banners to header file.
260266
- Removes `throw()` from header files, uses `noexcept` instead.
261-
- Adds basic and sqlite `std::move` test case.
267+
- Adds basic and SQLite `std::move` test case.
262268

263-
# v2.6.0
269+
## v2.6.0
264270

265271
- Resolves issue with decimal digits/scale and rounding. Thanks dedomilo!
266272
- Resolve issue with `DECIMAL` to string conversion. Thanks dedomilo!
267273

268-
# v2.5.1
274+
## v2.5.1
269275

270-
- Disable default unicode on windows.
276+
- Disable default Unicode on windows.
271277
- Override ODBC version with `NANODBC_ODBC_VERSION`.
272278

273-
# v2.4.0
279+
## v2.4.0
274280

275281
- Add `statement::async_execute_direct` and `statement::async_complete`. Thanks Jon Valvatne!
276282
- Add NOEXCEPT define to allow compilation under Visual Studio 2013.
277283

278-
# v2.3.0
284+
## v2.3.0
279285

280-
- Provides optional Boost workaround for missing codecvt support in libstdc++.
286+
- Provides optional Boost workaround for missing `codecvt` support in libstdc++.
281287

282-
# v2.2.3
288+
## v2.2.3
283289

284290
- Adds minimap banners for code navigation.
285291
- Adds `column_c_datatype()`.
286-
- Converts line endings to unix.
292+
- Converts line endings to Unix.
287293
- Adds `just_execute` class of functions that don't create result objects.
288294

289-
# v2.1.0
295+
## v2.1.0
290296

291297
- Adds publish script.
292298
- Fixes broken links in readme.
293299
- Use C++11's `=delete` where appropriate.
294300

295-
# v2.0.1
301+
## v2.0.1
296302

297303
- Fixes many documentation issues.
298-
- Adds more todo info about updating docs.
304+
- Adds more ToDo info about updating docs.
299305
- Adds notes about different versions.
300306
- Cleans up style; removes CPP11 macros and C++03 support cruft.
301307
- Silence warnings and untabify.
302-
- Works with Unicode (std::wstring as nanodbc::string_type)
303-
- Using nanodbc with SQL Server Native Client works with nvarchar(max) and varchar(max) fields in Win32 and Win64.
308+
- Works with Unicode (`std::wstring` as `nanodbc::string_type`)
309+
- Using nanodbc with SQL Server Native Client works with `nvarchar(max)` and `varchar(max)` fields in Win32 and Win64.
304310

305-
# v1.0.0
311+
## v1.0.0
306312

307313
Version 1.0.0 and all commits prior are now completely unsupported.

doc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ rstcheck -r doc
4141

4242
## Build
4343

44-
```
44+
```console
4545
pushd doc && make clean && make html && popd
4646
```
4747

0 commit comments

Comments
 (0)