Support README.adoc as fallback for library descriptions#2275
Open
Support README.adoc as fallback for library descriptions#2275
Conversation
jlchilders11
approved these changes
Apr 6, 2026
Collaborator
jlchilders11
left a comment
jlchilders11
left a comment
There was a problem hiding this comment.
Looks good to me, seems like a clean switch over to using the new file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2182
Adds README.adoc as a third fallback option in Library.get_description, tried after doc/library-detail.adoc and README.md.
Locally, Boost.URL, version 1.91.0-beta1 now shows a library description from its README.adoc (note there is a pre-existing table stretching display bug):
