Apply the C-EVOCATIVE guideline to options!
#2480
Merged
Conversation
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
The Rust API Guidelines state that macors should keep the input syntax
of a macro similar to the Rust syntax when possible.
The `options!` macro input followed this format:
```rust
field: {
ty: Ty,
...
}
```
However, the following syntax should be better:
```rust
field: ty {
...
}
```
This is done because the `options!` macro defines a `struct` and these
changes still evoke the common `field: ty` syntax followed by Rust.
See
https://rust-lang.github.io/api-guidelines/macros.html#input-syntax-is-evocative-of-the-output-c-evocative.
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.
The Rust API Guidelines state that macors should keep the input syntax of a macro similar to the Rust syntax when possible.
The
options!macro input followed this format:However, the following syntax should be better:
This is done because the
options!macro defines astructand these changes still evoke the commonfield: tysyntax followed by Rust.See
https://rust-lang.github.io/api-guidelines/macros.html#input-syntax-is-evocative-of-the-output-c-evocative.