-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(macos): explicitly mention which fields are skipped (#255)
* docs(macos): explicitly mention which fields are skipped 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. * add change file
- Loading branch information
1 parent
7b234b5
commit 753ec77
Showing
2 changed files
with
19 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
"cargo-packager": "patch" | ||
"@crabnebula/packager": "patch" | ||
--- | ||
|
||
Explicitly mention which fields in `Config` and other configuration structs | ||
are skipped during deserialization. | ||
This reduces confusion for new users looking at the docs for `Config`, | ||
who may receive unexpected errors when attempting to specify skipped fields | ||
in their config files or Cargo package metadata. | ||
|
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