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 the paragraph separation issue in the documentation #2793

Merged
merged 1 commit into from
Jan 11, 2024

Conversation

ashtum
Copy link
Collaborator

@ashtum ashtum commented Jan 10, 2024

Fixes #2792

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://2793.beastdocs.prtest.cppalliance.org/libs/beast/doc/html/index.html

@ashtum
Copy link
Collaborator Author

ashtum commented Jan 10, 2024

This breaks some of the new comment blocks because the authors have been relying on the fact that paragraphs in the comment block will not separate in the generated HTML pages.

Like:
Screenshot from 2024-01-10 18-42-23

I'll fix them as part of this PR.

Copy link

codecov bot commented Jan 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a0a8035) 93.01% compared to head (e6dcacf) 93.04%.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2793      +/-   ##
===========================================
+ Coverage    93.01%   93.04%   +0.02%     
===========================================
  Files          178      178              
  Lines        13688    13688              
===========================================
+ Hits         12732    12736       +4     
+ Misses         956      952       -4     
Files Coverage Δ
include/boost/beast/websocket/stream.hpp 100.00% <ø> (ø)

... and 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a0a8035...e6dcacf. Read the comment docs.

@ashtum ashtum force-pushed the fix-doc-paragraph-separations branch from 72bae09 to e6dcacf Compare January 10, 2024 17:49
@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://2793.beastdocs.prtest.cppalliance.org/libs/beast/doc/html/index.html

@ashtum ashtum merged commit ea424f1 into boostorg:develop Jan 11, 2024
39 checks passed
@ashtum ashtum changed the title Fix the issue of paragraph separation in the documentation Fix the paragraph separation issue in the documentation Jan 11, 2024
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.

zlib::deflate_stream::write documentation wall of text
2 participants