You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Only one guide so looks odd, perhaps move its one guide "How to Fill Elements....." to "Advanced Usage" at an appropriate spot and delete the How to Guides heading. OR perhaps delete the "Advanced Usage" heading and replace it with "How to Guides" as that seems more accurate.
Advanced Usage in the menu turns into "Tutorial" in the text. Perhaps choose one title ("How to Guides" might work the best) and use this one title to replace "Advanced usage" and "Tutorial" - as it seems the usage is not particularly advanced, nor is it laid out as a step-by-step tutorial.
Inconsistent capitalization in headings:
Personally, I prefer all non-noise words to be capitalized, for example: "Slices and Strides" is good. However, on the following page the capitalization is inconsistent, for example:
"Addressing subarrays" - I would have preferred this to be "Addressing Subarrays" - makes the heading look more assertive: https://correaa.github.io/boost-multi/multi/tutorial.html#tutorial_const_correctness
Headings in general are not great, just labels such as "Restrictions". For the How to Guides/Advanced Topics" I would have preferred dynamic action headings - replacing labels such as "Restrictions" with a more compelling "Delay Evaluation with Restriction Arrays"
Replace "Const-correctness" with "Disallow Mutation with Const-correctness"
Replace "Uninitialized vs. Initialized Elements" with "Avoid the Pitfalls of Uninitialized Elements" or similar
Replace "Conversions" with "Change Behavior with Conversions"
Replace "Slices and Strides" with "Slice and Stride your Arrays"
Replace "Indexing" with "Index rather than Iterate through your Arrays"
nit: I think you mean "extensively" not "intensively" in the following:
The implementation uses if constexpr intensively.
In general, I think users will be able to find what they are looking for within your documentation so I would vote to ACCEPT the library from the doc point of view.
How to Guides
Only one guide so looks odd, perhaps move its one guide "How to Fill Elements....." to "Advanced Usage" at an appropriate spot and delete the How to Guides heading. OR perhaps delete the "Advanced Usage" heading and replace it with "How to Guides" as that seems more accurate.
Advanced Usage in the menu turns into "Tutorial" in the text. Perhaps choose one title ("How to Guides" might work the best) and use this one title to replace "Advanced usage" and "Tutorial" - as it seems the usage is not particularly advanced, nor is it laid out as a step-by-step tutorial.
Inconsistent capitalization in headings:
Personally, I prefer all non-noise words to be capitalized, for example: "Slices and Strides" is good. However, on the following page the capitalization is inconsistent, for example:
"Addressing subarrays" - I would have preferred this to be "Addressing Subarrays" - makes the heading look more assertive:
https://correaa.github.io/boost-multi/multi/tutorial.html#tutorial_const_correctness
Headings in general are not great, just labels such as "Restrictions". For the How to Guides/Advanced Topics" I would have preferred dynamic action headings - replacing labels such as "Restrictions" with a more compelling "Delay Evaluation with Restriction Arrays"
Replace "Const-correctness" with "Disallow Mutation with Const-correctness"
Replace "Uninitialized vs. Initialized Elements" with "Avoid the Pitfalls of Uninitialized Elements" or similar
Replace "Conversions" with "Change Behavior with Conversions"
Replace "Slices and Strides" with "Slice and Stride your Arrays"
Replace "Indexing" with "Index rather than Iterate through your Arrays"
same idea for all the other headings in this section - active headings are not needed in Reference style sections (including Interoperability)
https://correaa.github.io/boost-multi/multi/tutorial.html#tutorial_const_correctness
Technical Points
Reference (auto generated)
Many API components are missing Descriptions, for example:
https://correaa.github.io/boost-multi/multi/reference/index.html
Member Functions are not alphabetically listed - for example:
https://correaa.github.io/boost-multi/multi/reference/boost/multi/elements_iterator_t.html
https://correaa.github.io/boost-multi/multi/reference/boost/multi.html
Not quite sure why "deprecated" types should be mentioned at all in a newly released library?:
https://correaa.github.io/boost-multi/multi/reference/boost/multi.html
Why Is the C++17 Standard Chosen as the Minimum?
nit: I think you mean "extensively" not "intensively" in the following:
The implementation uses if constexpr intensively.
In general, I think users will be able to find what they are looking for within your documentation so I would vote to ACCEPT the library from the doc point of view.