Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add warning block support in rustdoc #106561

Merged
merged 3 commits into from
Aug 21, 2023
Merged

Add warning block support in rustdoc #106561

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift click to select a range
d51521e
Add warning block support in rustdoc
GuillaumeGomez Jan 7, 2023
57d2b84
Add documentation for warning blocks in rustdoc book
GuillaumeGomez Jan 7, 2023
1d42913
Add GUI test for warning blocks
GuillaumeGomez Jan 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add GUI test for warning blocks
  • Loading branch information
@GuillaumeGomez
GuillaumeGomez committed Aug 14, 2023
commit 1d42913058d4005655ea51b2d9dde707791c6541
3 changes: 2 additions & 1 deletion src/doc/rustdoc/src/how-to-write-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 256,8 @@ So, no need to manually enter those Unicode characters!

### Adding a warning block

If you want to make a "warning" stand out in the documentation, you can wrap it like this:
If you want to make a warning or similar note stand out in the documentation,
you can wrap it like this:

```md
/// documentation
Expand Down
12 changes: 12 additions & 0 deletions tests/rustdoc-gui/src/test_docs/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 65,18 @@ impl Foo {
pub fn must_use(&self) -> bool {
true
}

/// hello
///
/// <div id="doc-warning-1" class="warning">this is a warning</div>
///
/// done
pub fn warning1() {}

/// Checking there is no bottom margin if "warning" is the last element.
///
/// <div id="doc-warning-2" class="warning">this is a warning</div>
pub fn warning2() {}
}

impl AsRef<str> for Foo {
Expand Down
45 changes: 45 additions & 0 deletions tests/rustdoc-gui/warning-block.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,45 @@
// Test to check that the "warning blocks" are displayed as expected.
go-to: "file://" |DOC_PATH| "/test_docs/struct.Foo.html"
show-text: true

define-function: (
"check-warning",
(theme, color, border_color, background_color),
block {
set-local-storage: {"rustdoc-theme": |theme|, "rustdoc-use-system-theme": "false"}
reload:

// The IDs are added directly into the DOM to make writing this test easier.
assert-css: ("#doc-warning-1", {
"margin-bottom": "12px",
"color": |color|,
"border-left": "2px solid " |border_color|,
"background-color": |background_color|,
})
assert-css: ("#doc-warning-2", {
"margin-bottom": "0px",
"color": |color|,
"border-left": "2px solid " |border_color|,
"background-color": |background_color|,
})
},
)

call-function: ("check-warning", {
"theme": "ayu",
"color": "rgb(197, 197, 197)",
"border_color": "rgb(255, 142, 0)",
"background_color": "rgba(0, 0, 0, 0)",
})
call-function: ("check-warning", {
"theme": "dark",
"color": "rgb(221, 221, 221)",
"border_color": "rgb(255, 142, 0)",
"background_color": "rgba(0, 0, 0, 0)",
})
call-function: ("check-warning", {
"theme": "light",
"color": "rgb(0, 0, 0)",
"border_color": "rgb(255, 142, 0)",
"background_color": "rgba(0, 0, 0, 0)",
})
Loading