Clarify tiers of support for compilers #156
Merged
Conversation
This file contains 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
We'll provide 3 tiers: full support, best effort, and assumed support. The new doc explains what these 3 tiers mean. The motivation behind this division is in part due to my experience working on mpusz/mp-units#300. That project got stalled for multiple months because I couldn't iterate locally on an issue we encountered with the MSVC compiler (which turned out to be a compiler bug!). Therefore, the compilers which _do_ let us iterate locally get the highest level of support. Next up is "anything we can make a CI job for", including several Windows/MSVC configurations. We plan to keep these passing always, although a time might come when something in this tier gets dropped because it's too painful to maintain. The final tier is "assumed support", which is just what it sounds like. I also added the new badgest to the README.md. I thought about adding a section for compiler support, but it didn't flow well, and besides, everybody understands more or less what the badges mean --- we can revisit this if and when any of them ever start failing. Fixes #144.
chiphogg
added
the
release notes: 📝 documentation
-Edited punctuation -Clarified text in the last paragraph of "Continuing your journey"
Headers -> Sentence case
johnzoppina
reviewed
Jul 31, 2023
docs/index.md
Outdated
| @@ -15,6 +15,10 @@ These pages will be most useful as you begin your Au journey: | |||
| What else is out there? This page gives a detailed comparison to some of the most prominent other | |||
| C++ units libraries. | |||
|
|
|||
| - **[Supported Compilers](./supported-compilers.md).** Au aims to work with _any_ C++ compiler with full | |||
| support for C++14 or later. That said, some platform/compiler combinations have more detailed | |||
There was a problem hiding this comment.
"with...with"
How about,
Au aims to work with any C++ compiler that fully supports C++14 or later.
connorjak
approved these changes
Aug 5, 2023
tobin
approved these changes
Aug 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We'll provide 3 tiers: full support, best effort, and assumed support.
The new doc explains what these 3 tiers mean.
The motivation behind this division is in part due to my experience
working on mpusz/mp-units#300. That project got stalled for multiple
months because I couldn't iterate locally on an issue we encountered
with the MSVC compiler (which turned out to be a compiler bug!).
Therefore, the compilers which do let us iterate locally get the
highest level of support. Next up is "anything we can make a CI job
for", including several Windows/MSVC configurations. We plan to keep
these passing always, although a time might come when something in this
tier gets dropped because it's too painful to maintain. The final tier
is "assumed support", which is just what it sounds like.
I also added the new badgest to the README.md. I thought about adding a
section for compiler support, but it didn't flow well, and besides,
everybody understands more or less what the badges mean --- we can
revisit this if and when any of them ever start failing.
Fixes #144.