Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix doc warnings #120

Merged
merged 3 commits into from
Jan 2, 2024
Merged

Conversation

Lastique
Copy link
Member

@Lastique Lastique commented Jan 2, 2024

A few commits that fix a few warnings produced when building docs:

  • b2 warning about using reserved characters in parameter values
  • QuickBook warnings about invalid characters
  • QuickBook warnings about line breaks potentially producing invalid Boost.Book output. Also fixes broken output for IO operator reference.

None of these are "fatal" errors, i.e. the docs are building successfully even with the warnings. But worth fixing anyway.

The previous IO operator declarations were made up from multiple
code phrase markups with line breaks, where the markup was broken and
some of the line breaks were not translated propertly into output.

Replace this with proper code blocks. This also resolves the
QuickBook warning about line breaks potentially producing invalid
BoostBook output.
@akrzemi1 akrzemi1 merged commit 034dfe2 into boostorg:develop Jan 2, 2024
15 of 16 checks passed
@Lastique Lastique deleted the feature/fix_doc_warnings branch January 2, 2024 16:48
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