Merge rust-bitcoin/rust-bitcoin#877: Improve ClassifyContext rustdocs
51a51cd67d
Improve ClassifyContext rustdocs (Tobin Harding) Pull request description: Improve the rustdocs on the `ClassifyContext` enum by doing: - Use link for `OP_RESERVED` - Use term `OP_SUCCESSx` is done in BIP342 (no code link, does not exist in code). - Use enum::variant form for both variant mentions - Direct readers to BIP342 for full list of opcode re-names ACKs for top commit: sanket1729: ACK51a51cd67d
apoelstra: ACK51a51cd67d
dr-orlovsky: ACK51a51cd67d
Tree-SHA512: 1a9067246ef84eae39b0adef64190b9212dacb55a420909ee38c582ef1960fceb572f82d3eeff518b58fc2cceffe71b3da4e78da54cd4cb6e05a0e48a3a9d03c
This commit is contained in:
commit
443a38567b
|
@ -661,8 +661,8 @@ impl fmt::Debug for All {
|
||||||
|
|
||||||
/// Classification context for the opcode.
|
/// Classification context for the opcode.
|
||||||
///
|
///
|
||||||
/// Some opcodes like `OP_RESERVED` abort the script in [`ClassifyContext::Legacy`] context, but
|
/// Some opcodes like [`all::OP_RESERVED`] abort the script in `ClassifyContext::Legacy` context,
|
||||||
/// will act as `OP_SUCCESS` in tapscript.
|
/// but will act as `OP_SUCCESSx` in `ClassifyContext::TapScript` (see BIP342 for full list).
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
pub enum ClassifyContext {
|
pub enum ClassifyContext {
|
||||||
/// Opcode used in tapscript context.
|
/// Opcode used in tapscript context.
|
||||||
|
|
Loading…
Reference in New Issue