Skip to content

Commit

Permalink
[prdoc] Support multiple audiences (#3990)
Browse files Browse the repository at this point in the history
Closes #3986

---------

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
  • Loading branch information
ggwpez authored Apr 5, 2024
1 parent 03e9dd7 commit d3eba36
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/sdk/src/reference_docs/frame_tokens.rs
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
//! [`fungible::Inspect`](`frame_support::traits::fungible::Inspect`) is not some arcane knowledge
//! that you have to know by heart or memorize. One can simply look at the list of the implementors
//! of any trait in the Rust Doc to find all implementors (e.g.
//! <https://paritytech.github.io/polkadot-sdk/master/frame/traits/tokens/fungible/trait.Mutate.html#implementors>),
//! <https://paritytech.github.io/polkadot-sdk/master/frame_support/traits/tokens/fungible/trait.Mutate.html#implementors>),
//! or use the `rust-analyzer` `Implementations` action.
//!
//! ## Fungible Token Traits in FRAME
Expand Down
19 changes: 18 additions & 1 deletion prdoc/schema_user.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,12 @@
"$defs": {
"audience": {
"description": "You may pick one or more audiences and address those users with appropriate documentation, information and warning related to the PR.",
"oneOf": [
{ "$ref": "#/$defs/audience_id" },
{ "$ref": "#/$defs/audience_ids" }
]
},
"audience_id": {
"oneOf": [
{"const": "Node Dev",
"title": "Node Dev",
Expand All @@ -116,6 +122,13 @@
"description": "Anyone using the runtime. This can be a token holder or a dev writing a front end for a chain."}
]
},
"audience_ids": {
"type": "array",
"items": {
"$ref": "#/$defs/audience_id"
},
"minItems": 2
},
"crate": {
"type": "object",
"description": "You have the option here to provide a hint about a crate that has changed to help with the publishing of crates.",
Expand Down Expand Up @@ -209,7 +222,11 @@
"description": "Description of the change",
"type": "string"
}
}
},
"required": [
"audience",
"description"
]
},
"array_of_strings": {
"description": "An array of strings that can be empty",
Expand Down

0 comments on commit d3eba36

Please sign in to comment.