Skip to content

Commit 7bec2db

Browse files
committed
Auto merge of #3430 - RalfJung:doc, r=RalfJung
make some doc comments not doc tests `./miri test --doc` will run doctests even if we have them disabled (that's a cargo quirk: rust-lang/cargo#13668). This fixes that command to not fail.
2 parents 4d0b9c2 + 278869b commit 7bec2db

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

src/borrow_tracker/tree_borrows/diagnostics.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ type S = &'static str;
365365
/// Pretty-printing details
366366
///
367367
/// Example:
368-
/// ```
368+
/// ```rust,ignore (private type)
369369
/// DisplayFmtWrapper {
370370
/// top: '>',
371371
/// bot: '<',
@@ -393,7 +393,7 @@ struct DisplayFmtWrapper {
393393
/// Formating of the permissions on each range.
394394
///
395395
/// Example:
396-
/// ```
396+
/// ```rust,ignore (private type)
397397
/// DisplayFmtPermission {
398398
/// open: "[",
399399
/// sep: "|",
@@ -425,7 +425,7 @@ struct DisplayFmtPermission {
425425
/// Formating of the tree structure.
426426
///
427427
/// Example:
428-
/// ```
428+
/// ```rust,ignore (private type)
429429
/// DisplayFmtPadding {
430430
/// join_middle: "|-",
431431
/// join_last: "'-",
@@ -463,7 +463,7 @@ struct DisplayFmtPadding {
463463
/// How to show whether a location has been accessed
464464
///
465465
/// Example:
466-
/// ```
466+
/// ```rust,ignore (private type)
467467
/// DisplayFmtAccess {
468468
/// yes: " ",
469469
/// no: "?",

src/borrow_tracker/tree_borrows/unimap.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ where
132132
/// the associated `UniIndex` from ALL `UniValMap`s.
133133
///
134134
/// Example of such behavior:
135-
/// ```
135+
/// ```rust,ignore (private type can't be doctested)
136136
/// let mut keymap = UniKeyMap::<char>::default();
137137
/// let mut valmap = UniValMap::<char>::default();
138138
/// // Insert 'a' -> _ -> 'A'

0 commit comments

Comments
 (0)