Skip to content

Commit

Permalink
update docs on activation_height() method
Browse files Browse the repository at this point in the history
  • Loading branch information
arya2 committed Apr 23, 2024
1 parent 0f91dd0 commit b7ddb90
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions zebra-chain/src/parameters/network_upgrade.rs
Original file line number Diff line number Diff line change
Expand Up @@ -326,10 +326,13 @@ impl NetworkUpgrade {
/// such as on Regtest or a configured Testnet where multiple network upgrades have the
/// same activation height, or if one is omitted when others that follow it are included.
///
/// Returns None if this network upgrade is a future upgrade, and its
/// activation height has not been set yet.
///
/// Returns None if this network upgrade has not been configured on a Testnet or Regtest.
/// Returns [`Height::MAX`] if no activation height is set for this network upgrade or any

Check failure on line 329 in zebra-chain/src/parameters/network_upgrade.rs

View workflow job for this annotation

GitHub Actions / Build and Deploy Zebra Internal Docs

unresolved link to `Height::MAX`
/// future network upgrade.
// TODO:
// Returns None if this network upgrade is a future upgrade, and its
// activation height has not been set yet.
//
// Returns None if this network upgrade has not been configured on a Testnet or Regtest.
pub fn activation_height(&self, network: &Network) -> Option<block::Height> {
network
.activation_list()
Expand Down

0 comments on commit b7ddb90

Please sign in to comment.