Improve docs on ClassifyContext

Improve docs on `ClassifyContext` by doing:

- Separate brief doc line from the rest
- Use uniform backticks on opcodes
This commit is contained in:
Tobin Harding 2022-03-09 13:51:52 +11:00
parent f733dc0bbf
commit 8a1cc2ca77
1 changed files with 4 additions and 2 deletions

View File

@ -660,8 +660,10 @@ impl fmt::Debug for All {
} }
/// Classification context for the opcode. Some opcodes like `OP_RESERVED` /// Classification context for the opcode.
/// abort the script in [`ClassifyContext::Legacy`] context, but will act as OP_SUCCESS in tapscript ///
/// Some opcodes like `OP_RESERVED` abort the script in [`ClassifyContext::Legacy`] context, but
/// will act as `OP_SUCCESS` in tapscript.
#[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