Skip to content

Commit

Permalink
Un-hide docs for internal traits
Browse files Browse the repository at this point in the history
  • Loading branch information
aborgna-q committed May 29, 2024
1 parent d1470b5 commit 1e1e369
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions hugr-core/src/hugr/internal.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ use super::{HugrError, NodeType, RootTagged};
///
/// Specifically, this trait provides access to the underlying portgraph
/// view.
#[doc(hidden)]
pub trait HugrInternals {
/// The underlying portgraph view type.
type Portgraph<'p>: LinkView + Clone + 'p
Expand Down Expand Up @@ -54,7 +53,6 @@ impl<T: AsRef<Hugr>> HugrInternals for T {
///
/// Specifically, this trait lets you apply arbitrary modifications that may
/// invalidate the HUGR.
#[doc(hidden)]
pub trait HugrMutInternals: RootTagged {
/// Returns the Hugr at the base of a chain of views.
fn hugr_mut(&mut self) -> &mut Hugr;
Expand Down Expand Up @@ -135,7 +133,7 @@ pub trait HugrMutInternals: RootTagged {
/// # Errors
///
/// Returns a [`HugrError::InvalidTag`] if this would break the bound
/// ([`Self::RootHandle`]) on the root node's [OpTag].
/// (`Self::RootHandle`) on the root node's OpTag.
///
/// # Panics
///
Expand Down

0 comments on commit 1e1e369

Please sign in to comment.