Skip to content

Commit

Permalink
Add GUI test for impl block doc display
Browse files Browse the repository at this point in the history
  • Loading branch information
GuillaumeGomez committed Oct 25, 2024
1 parent b0e8ad5 commit 30f487c
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
33 changes: 33 additions & 0 deletions tests/rustdoc-gui/impl-block-doc.goml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Checks that the first sentence of an impl block doc is always visible even when the impl
// block is collapsed.
go-to: "file://" + |DOC_PATH| + "/test_docs/struct.ImplDoc.html"

set-window-size: (900, 600)

define-function: (
"compare-size-and-pos",
[nth_impl],
block {
// First we collapse the impl block.
store-value: (impl_path, "#implementations-list details:nth-of-type(" + |nth_impl| + ")")
set-property: (|impl_path|, {"open": false})
wait-for: |impl_path| + ":not([open])"

store-value: (impl_path, |impl_path| + " summary")
store-size: (|impl_path|, {"height": impl_height})
store-position: (|impl_path|, {"y": impl_y})

store-size: (|impl_path| + " .docblock", {"height": doc_height})
store-position: (|impl_path| + " .docblock", {"y": doc_y})

assert: |impl_y| + |impl_height| >= |doc_y|
}
)

call-function: ("compare-size-and-pos", {"nth_impl": 1})
// Since the first impl block has a long line, we ensure that it doesn't display all of it.
assert: (|impl_y| + |impl_height|) <= (|doc_y| + |doc_height|)

call-function: ("compare-size-and-pos", {"nth_impl": 2})
// The second impl block has a short line.
assert: (|impl_y| + |impl_height|) >= (|doc_y| + |doc_height|)
17 changes: 17 additions & 0 deletions tests/rustdoc-gui/src/test_docs/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -652,3 +652,20 @@ pub mod long_list {
//! * [`FromBytes`](#a) indicates that a type may safely be converted from an arbitrary byte
//! sequence
}

pub struct ImplDoc;

/// bla sondfosdnf sdfasd fadsd fdsa f ads fad sf sad f sad fasdfsafsa df dsafasdasd fsa dfadsfasd
/// fads fadfadd
///
/// bla
impl ImplDoc {
pub fn bar() {}
}

/// bla
///
/// bla
impl ImplDoc {
pub fn bar2() {}
}

0 comments on commit 30f487c

Please sign in to comment.