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:
    ACK 51a51cd67d
  apoelstra:
    ACK 51a51cd67d
  dr-orlovsky:
    ACK 51a51cd67d

Tree-SHA512: 1a9067246ef84eae39b0adef64190b9212dacb55a420909ee38c582ef1960fceb572f82d3eeff518b58fc2cceffe71b3da4e78da54cd4cb6e05a0e48a3a9d03c
This commit is contained in:
Dr. Maxim Orlovsky 2022-03-20 20:40:06 +02:00
commit 443a38567b
No known key found for this signature in database
GPG Key ID: AF91255DEA466640
1 changed files with 2 additions and 2 deletions

View File

@ -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.