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

Document layout SemVer compatibility. #12169

Merged
merged 10 commits into from
Aug 18, 2023
Merged

Document layout SemVer compatibility. #12169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3cff9d5
Document layout semver compatibility.
ehuss May 23, 2023
661287e
Apply some edits from review to try to clarify things.
ehuss Jun 14, 2023
4c1d8f1
Document the special code block annotations.
ehuss Jun 15, 2023
96da3c4
Support hidden lines.
ehuss Jun 15, 2023
406f434
Split out all layout rules into separate sections with examples.
ehuss Jun 15, 2023
99d2aa9
Clarify what it means "to document" a transparent type.
ehuss Jul 12, 2023
9e274d0
Apply changes from review from obi1kenobi.
ehuss Aug 6, 2023
58aef64
Add "reordering" to list of changes.
ehuss Aug 12, 2023
a2b36f6
Updates from review from joshtriplett
ehuss Aug 18, 2023
5dc86dc
Use header IDs
ehuss Aug 18, 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
13 changes: 12 additions & 1 deletion crates/semver-check/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@
//! An example with the word "MINOR" at the top is expected to successfully
//! build against the before and after. Otherwise it should fail. A comment of
//! "// Error:" will check that the given message appears in the error output.
//!
//! The code block can also include the annotations:
//! - `run-fail`: The test should fail at runtime, not compiletime.
//! - `dont-deny`: By default tests have a `#![deny(warnings)]`. This option
//! avoids this attribute. Note that `#![allow(unused)]` is always added.

use std::error::Error;
use std::fs;
Expand Down Expand Up @@ -57,7 +62,13 @@ fn doit() -> Result<(), Box<dyn Error>> {
if line.trim() == "```" {
break;
}
block.push(line);
// Support rustdoc/mdbook hidden lines.
let line = line.strip_prefix("# ").unwrap_or(line);
if line == "#" {
block.push("");
} else {
block.push(line);
}
}
None => {
return Err(format!(
Expand Down
Loading