From 51a51cd67d7b81f9f8f02f1590ccd90e744d7e48 Mon Sep 17 00:00:00 2001 From: Tobin Harding Date: Tue, 15 Mar 2022 14:36:59 +1100 Subject: [PATCH] Improve ClassifyContext rustdocs 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 --- src/blockdata/opcodes.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/blockdata/opcodes.rs b/src/blockdata/opcodes.rs index af22cbf3..56763bb7 100644 --- a/src/blockdata/opcodes.rs +++ b/src/blockdata/opcodes.rs @@ -661,8 +661,8 @@ impl fmt::Debug for All { /// Classification context for the opcode. /// -/// Some opcodes like `OP_RESERVED` abort the script in [`ClassifyContext::Legacy`] context, but -/// will act as `OP_SUCCESS` in tapscript. +/// Some opcodes like [`all::OP_RESERVED`] abort the script in `ClassifyContext::Legacy` context, +/// but will act as `OP_SUCCESSx` in `ClassifyContext::TapScript` (see BIP342 for full list). #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] pub enum ClassifyContext { /// Opcode used in tapscript context.