Improve documentation of derive macros #429
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
turion
force-pushed
the
dev_improve_docs
branch
from
395507a
to
5364044
Compare
hansihe
reviewed
Feb 14, 2022
rustler_codegen/src/lib.rs
Outdated
| /// Implementation of the `NifStruct` macro that lets the user annotate a struct that will | ||
| /// be translated directly from an Elixir struct to a Rust struct. For example, the following | ||
| /// struct, annotated as such: | ||
| /// Create a correspondence between an Elixir struct and a Rust struct. |
There was a problem hiding this comment.
Macro for automatically deriving
EncoderandDecoderimplementations which convert between a Rust struct and an Elixir struct.
How about something like this? In my mind the word correspondence might not be the most descriptive in this case.
There was a problem hiding this comment.
The same also applies in the other cases this wording is used.
There was a problem hiding this comment.
That's definitely an improvement! I changed the wording further, hopefully keeping your spirit.
turion
force-pushed
the
dev_improve_docs
branch
from
5364044
to
c2ec2d7
Compare
|
@hansihe What do you think about this version? |
philss
approved these changes
Apr 12, 2022
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.
This clarifies the usage of the
Nif*derive macros a bit, and removes a few small errors.