mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-17 19:25:41 +00:00
Kevin Krone
b6965af493
This is a port (and hopefully a small improvement) of @kianenigma's PR from the old Substrate repo: https://github.com/paritytech/substrate/pull/13987. Following #1689 I moved the documentation of all macros relevant to this PR from `frame_support_procedural` to `pallet_macros` while including a hint for RA users. Question: Again with respect to #1689: Is there a good reason why we should *not* enhance paths with links to our current rustdocs? For example, instead of ```rust /// **Rust-Analyzer users**: See the documentation of the Rust item in /// `frame_support::pallet_macros::storage`. ``` we could write ```rust /// **Rust-Analyzer users**: See the documentation of the Rust item in /// [`frame_support::pallet_macros::storage`](https://paritytech.github.io/polkadot-sdk/master/frame_support/pallet_macros/attr.storage.html). ``` This results in a clickable link like this: <img width="674" alt="image" src="https://github.com/paritytech/polkadot-sdk/assets/10713977/c129e622-3942-4eeb-8acf-93ee4efdc99d"> I don't really expect the links to become outdated any time soon, but I think this would be a great UX improvement over just having paths. TODOs: - [ ] Add documentation for `constant_name` macro - [x] Add proper documentation for different `QueryKinds`, i.e. `OptionQuery`, `ValueQuery`, `ResultQuery`. One example for each. Custom `OnEmpty` should be moved to `QueryKinds` trait doc page. - [ ] Rework `type_value` docs --------- Co-authored-by: kianenigma <kian@parity.io>
94 lines
2.7 KiB
TOML
94 lines
2.7 KiB
TOML
[package]
|
|
name = "pallet-bags-list"
|
|
version = "4.0.0-dev"
|
|
authors.workspace = true
|
|
edition.workspace = true
|
|
license = "Apache-2.0"
|
|
homepage = "https://substrate.io"
|
|
repository.workspace = true
|
|
description = "FRAME pallet bags list"
|
|
|
|
[package.metadata.docs.rs]
|
|
targets = ["x86_64-unknown-linux-gnu"]
|
|
|
|
[dependencies]
|
|
# parity
|
|
codec = { package = "parity-scale-codec", version = "3.6.1", default-features = false, features = [
|
|
"derive",
|
|
] }
|
|
scale-info = { version = "2.10.0", default-features = false, features = [
|
|
"derive",
|
|
] }
|
|
|
|
# primitives
|
|
sp-runtime = { path = "../../primitives/runtime", default-features = false }
|
|
sp-std = { path = "../../primitives/std", default-features = false }
|
|
|
|
# FRAME
|
|
frame-support = { path = "../support", default-features = false }
|
|
frame-system = { path = "../system", default-features = false }
|
|
frame-election-provider-support = { path = "../election-provider-support", default-features = false }
|
|
|
|
# third party
|
|
log = { version = "0.4.17", default-features = false }
|
|
docify = "0.2.6"
|
|
aquamarine = { version = "0.3.2" }
|
|
|
|
# Optional imports for benchmarking
|
|
frame-benchmarking = { path = "../benchmarking", default-features = false, optional = true }
|
|
pallet-balances = { path = "../balances", default-features = false, optional = true }
|
|
sp-core = { path = "../../primitives/core", default-features = false, optional = true }
|
|
sp-io = { path = "../../primitives/io", default-features = false, optional = true }
|
|
sp-tracing = { path = "../../primitives/tracing", default-features = false, optional = true }
|
|
|
|
[dev-dependencies]
|
|
sp-core = { path = "../../primitives/core" }
|
|
sp-io = { path = "../../primitives/io" }
|
|
sp-tracing = { path = "../../primitives/tracing" }
|
|
pallet-balances = { path = "../balances" }
|
|
frame-election-provider-support = { path = "../election-provider-support" }
|
|
frame-benchmarking = { path = "../benchmarking" }
|
|
|
|
[features]
|
|
default = ["std"]
|
|
std = [
|
|
"codec/std",
|
|
"frame-benchmarking?/std",
|
|
"frame-election-provider-support/std",
|
|
"frame-support/std",
|
|
"frame-system/std",
|
|
"log/std",
|
|
"pallet-balances?/std",
|
|
"scale-info/std",
|
|
"sp-core?/std",
|
|
"sp-io?/std",
|
|
"sp-runtime/std",
|
|
"sp-std/std",
|
|
"sp-tracing?/std",
|
|
]
|
|
runtime-benchmarks = [
|
|
"frame-benchmarking/runtime-benchmarks",
|
|
"frame-election-provider-support/runtime-benchmarks",
|
|
"frame-support/runtime-benchmarks",
|
|
"frame-system/runtime-benchmarks",
|
|
"pallet-balances/runtime-benchmarks",
|
|
"sp-core",
|
|
"sp-io",
|
|
"sp-runtime/runtime-benchmarks",
|
|
"sp-tracing",
|
|
]
|
|
fuzz = [
|
|
"frame-election-provider-support/fuzz",
|
|
"pallet-balances",
|
|
"sp-core",
|
|
"sp-io",
|
|
"sp-tracing",
|
|
]
|
|
try-runtime = [
|
|
"frame-election-provider-support/try-runtime",
|
|
"frame-support/try-runtime",
|
|
"frame-system/try-runtime",
|
|
"pallet-balances?/try-runtime",
|
|
"sp-runtime/try-runtime",
|
|
]
|