Added documentation to the fields within derived read-only types #8334
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
read-only types.
alice-i-cecile
added
C-Docs
alice-i-cecile
approved these changes
Apr 9, 2023
CGMossa
approved these changes
Apr 9, 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.
Fixes #8333
Objective
Fixes issue which causes failure to compile if using
#![deny(missing_docs)].Solution
Added some very basic commenting to the generated read-only fields. honestly I feel this to be up for debate since the comments are very basic and give very little useful information but the purpose of this PR is to fix the issue at hand.
Changelog
Added comments to the derive macro and the projects now successfully compile.