Skip to content

Commit 8e5f934

Browse files
committed
(doc) refining release notes & NEWS
1 parent 7edf506 commit 8e5f934

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

NEWS.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Build
1717

1818
* C++ standard is std17
1919

20-
* Using this standard all versions of boost will work
20+
* Using this standard, all supported toolchains across our CI matrix will work.
2121
* The code is not yet modified to use std17:
2222

2323
* If needed: ``-DCMAKE_CXX_STANDARD=14`` to lower the standard.
2424

25-
* The user's documentation is build by default
26-
* The doxygen documentation is build by default
25+
* The user's documentation is built by default.
26+
* The doxygen documentation is built by default.
2727

2828
For developers:
2929

@@ -47,9 +47,9 @@ User's Documentation is not build when
4747

4848
* When all languages are OFF
4949

50-
* To build only English: `-DES=ON -DSV=OFF -DZH_HANS=OFF`
50+
* To build only English: `-DES=OFF -DSV=OFF -DZH_HANS=OFF`
5151

52-
* Documentation output changed location to [build/doc/_build/](format) directory
52+
* Documentation output location: [`build/doc/_build/](format)`
5353

5454
* For example: for HTML output is on `build/doc/_build/html` directory
5555

doc/src/release_notes.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ Build
5151

5252
* C++ standard is std17
5353

54-
* Using this standard all versions of boost will work
54+
* Using this standard, all supported toolchains across our CI matrix will work.
5555
* The code is not yet modified to use std17:
5656

5757
* If needed: ``-DCMAKE_CXX_STANDARD=14`` to lower the standard.
5858

59-
* The user's documentation is build by default
60-
* The doxygen documentation is build by default
59+
* The user's documentation is built by default.
60+
* The doxygen documentation is built by default.
6161

6262
For developers:
6363

@@ -82,9 +82,9 @@ User's Documentation is not build when
8282

8383
* When all languages are OFF
8484

85-
* To build only English: `-DES=ON -DSV=OFF -DZH_HANS=OFF`
85+
* To build only English: `-DES=OFF -DSV=OFF -DZH_HANS=OFF`
8686

87-
* Documentation output changed location to `build/doc/_build/<format>` directory
87+
* Documentation output location: ``build/doc/_build/<format>``
8888

8989
* For example: for HTML output is on `build/doc/_build/html` directory
9090

0 commit comments

Comments
 (0)