Improving wording related to Boost library requirements #7589
Conversation
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
Documentation was unclear in this section and could be interpreted to mean that boost was not a hard requirement for older Ubuntu versions. Related: #7587
jonathancross
changed the title
doc/build-unix.md
Outdated
| install necessary parts of boost: | ||
|
|
||
| sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-chrono-dev libboost-program-options-dev libboost-test-dev libboost-thread-dev | ||
| `sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-chrono-dev libboost-program-options-dev libboost-test-dev libboost-thread-dev` |
Contributor
There was a problem hiding this comment.
nit: IMO if you use a 4-spaces-indent that's equivalent to `
Member
There was a problem hiding this comment.
Yes, either do
install necessary parts of boost:
```bash
<commands go here>
```
Or indent four spaces:
install necessary parts of boost:
<commands go here>
Both is not valid markdown.
Contributor
Author
There was a problem hiding this comment.
Thank you both.
The Ordered list (numbers 1 and 2) formatting cause markdown to ignore the 4-space "code" indentation markup. I did some experimentation and now see that I need to indent 8 spaces to bring back the code formatting when in a list.
Now fixed.
Contributor
|
ACK 417e64b |
Merging in latest changes.
Documentation was unclear in this section and could be interpreted to mean that boost was not a hard requirement for older Ubuntu versions. Related: #7587 This squashed commit replaces backticks with additional 4-space code indentation.
Contributor
Author
|
I went ahead and created a new clean pull request #7590 with a single commit and the formatting changes requested. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 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.
Documentation was unclear in this section and could be interpreted to mean that boost was not a hard requirement for older Ubuntu versions.
Related: #7587