docs(macos): explicitly mention which fields are skipped #255
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
New users may be confused when looking at the docs for `Config` and other config-like structs, as some fields cannot be specified in config files or via Cargo's package metadata. This commit clarifies that those fields are intentionally excluded. Also added an example of a macOS developer signing identity.
|
I approved the workflows because this is non-controversial. Still need @lucasfernog-crabnebula or @amr-crabnebula to approve. |
denjell-crabnebula
requested review from
lucasfernog-crabnebula and
amr-crabnebula
lucasfernog-crabnebula
approved these changes
Jun 29, 2024
Thanks, yeah I should've mentioned it here, but for the sake of giving credit, Amr is the one who informed me of this originally: #246 (comment) |
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.
New users may be confused when looking at the docs for
Configand other config-like structs, as some fields cannot be specified in config files or via Cargo's package metadata.This commit clarifies that those fields are intentionally excluded.
Also added an example of a macOS developer signing identity.
Notes
I added this notice to the docs of only 3 fields, those that were annotated with
#[serde(skip)]. Let me know if there are any other fields that should have this notice too.