Feat req: DRY to target multiple `audience` with a common description

paritytech / prdoc

prdoc files are YAML files following a defined schema and helping with code change documentation.

MIT License

11 stars 1 forks source link

Feat req: DRY to target multiple `audience` with a common description #6

Closed nuke-web3 closed 1 year ago

nuke-web3 commented 1 year ago

I don't always want to explicitly tell every audience something different, sometimes I want to tell most or all audiences some of the same thing, and then further details explicitly for some subset or single audience.

nuke-web3 commented 1 year ago

Maybe we want to use a new required overall description field and make audience optional completely. So everyone can see the "blanket" detials, and audiences can be specified to know more info or nuance about it.

For example:

doc:
- description: This changes ... so that every existing account has 1 DOT minted to it 🤑

- audience: Core Dev
  description: This is an `Unbalanced` fungible operation, cause we wanna screw up accounting 🙈

chevdor commented 1 year ago

Fixed in https://github.com/paritytech/prdoc/pull/8