Add documentation of style conventions - #151
Open
DJMcNab wants to merge 4 commits into
Open
Conversation
tomcur
reviewed
Aug 31, 2026
|
|
||
| ### Taplo | ||
|
|
||
| We currently use Taplo for TOML formatting - config file looks something like: |
Member
There was a problem hiding this comment.
Do we have any that aren't exactly this?
If not, we could just say "We currently use Taplo for TOML formatting. Use the following config file."
Comment on lines
+107
to
+112
| By default, we do not promise to make our crates no-alloc. Crates which would otherwise be `no-alloc` should have a line such as: | ||
|
|
||
| ```rust | ||
| // Avoid adding alloc in the future being a breaking change. | ||
| extern crate alloc as _; | ||
| ``` |
Member
There was a problem hiding this comment.
I think color currently is no-alloc.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
These docs are entirely intended to make creating new crates easier, and to allow for LLM-assisted resyncing to the correct format.
This is my current understanding of our best practise, as currently we have to dig through piles of repos to find it all out.