Spurious warning

Open
#16 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
58/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
cpp
Domain
documentation

Research direction

Start at src/actions.cpp around line 265 and reproduce the warning with [br] in a QBK file. Trace why this valid input emits the warning, then verify that processing the input remains successful without the spurious warning so CI can treat documentation warnings as errors.

Written by the indexing model from the issue text.

Description

This produces a warning when you write [br] in a QBK file:

https://github.com/boostorg/quickbook/blob/5f2e8c24cb813b4b0b94d3316e664b971c5b71dd/src/actions.cpp#L265

Thing is... it works fine. There is no other "boostbook processor" on the horizon, so the warning is rather pointless. We want to make doc warnings into errors in our CI builds but this is in the way.

Dominant language
C++
Stars
15
Forks
34
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from boostorg/quickbook

All issues in boostorg/quickbook

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.