Add machinery for built-in constants, such as c
#335
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
For Au's built-in constants, we follow the exact same policies as for units, including: - A new include folder, `"au/constants/..."` - A new target, `"//au:constants"`, which globs headers from that folder - Corresponding unit tests - Inclusion in the single-file script by individual names - An `--all-constants` option for the single-file script We _don't_ provide `_fwd.hh` files, because there's nothing we could really forward declare. Constant objects are defined with spelled-out names in `ALL_CAPS` format. The corresponding file is the snake-case version. This keeps the constant itself unambiguous. We expect end users to actually use them in the following manner: ```cpp constexpr auto c = au::SPEED_OF_LIGHT; ``` Finally, we now mention new constants in the release notes. Helps #90. Remaining work includes adding more constants, and adding documentation.
chiphogg
added
release notes: ✨ lib (enhancement)
geoffviola
approved these changes
Dec 2, 2024
chiphogg
added
the
release notes: 🔨 tooling
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.
For Au's built-in constants, we follow the exact same policies as for
units, including:
"au/constants/...""//au:constants", which globs headers from that folder--all-constantsoption for the single-file scriptOh, and while I was updating the single-file script, I noticed a slight
"bug": ever since we started providing
_fwd.hhfiles for the units,the single file script was treating those files as their own units.
This doesn't hurt anything, but it's just a little silly (see image).
This PR fixes that bug as well.
We don't provide
_fwd.hhfiles for constants, because there'snothing we could really forward declare.
Constant objects are defined with spelled-out names in
ALL_CAPSformat. The corresponding file is the snake-case version. This keeps
the constant itself unambiguous. We expect end users to actually use
them in the following manner:
Finally, we now mention new constants in the release notes.
Helps #90. Remaining work includes adding more constants, and adding
documentation.