Skip to content

[doc] Drop the stray parameter from the on_bool handler docs - #1180

Open
karpovantonme wants to merge 1 commit into
boostorg:developfrom
karpovantonme:doc-on-bool-param
Open

[doc] Drop the stray parameter from the on_bool handler docs#1180
karpovantonme wants to merge 1 commit into
boostorg:developfrom
karpovantonme:doc-on-bool-param

Conversation

@karpovantonme

Copy link
Copy Markdown

The handler concept in basic_parser.hpp documents on_bool as taking the remaining characters:

/// Called when a boolean is parsed.
///
/// @return `true` on success.
/// @param b The value
/// @param s The remaining characters
/// @param ec Set to the error, if any occurred.
///
bool on_bool( bool b, error_code& ec );

There is no s. The line is a copy of the one in on_double right above it, which does take a string_view. on_null below has no such line, so on_bool is the only handler affected.

It matters a little more than a normal typo because this block is the specification users write their own handler against, so it tells them to expect an argument the parser never passes.

One line, comment only. I checked the rest of the library the same way and this is the only mismatch in it.

The handler concept documents on_bool as taking a string_view of the
remaining characters, but its declaration is
`bool on_bool( bool b, error_code& ec )`. The line is a copy of the one
in on_double above it, which really does take one. on_null below has no
such line, so this is the only handler affected.
@cppalliance-bot

Copy link
Copy Markdown

An automated preview of the documentation is available at https://1180.json.prtest2.cppalliance.org/libs/json/doc/html/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-08-03 15:03:51 UTC

@cppalliance-bot

Copy link
Copy Markdown

GCOVR code coverage report https://1180.json.prtest2.cppalliance.org/gcovr/index.html
LCOV code coverage report https://1180.json.prtest2.cppalliance.org/genhtml/index.html
Coverage Diff Report https://1180.json.prtest2.cppalliance.org/diff-report/index.html

Build time: 2026-08-03 15:13:50 UTC

@cppalliance-bot

Copy link
Copy Markdown

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.

2 participants