diff options
| author | Samuel Tardieu <sam@rfc1149.net> | 2025-08-02 11:24:24 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-08-02 11:24:24 +0200 |
| commit | d082ff4c04c09e855d7ea55e0c9deda05eba46ec (patch) | |
| tree | c0b95c7bf6b389d2fa07dea65c5fe427c153de73 /library/std/src | |
| parent | cafd9fb2d3f2b5179308f3c736341fa9cec61867 (diff) | |
| parent | 1e2d58798fab4aa6275acf3746e1aec5340fc97f (diff) | |
| download | rust-d082ff4c04c09e855d7ea55e0c9deda05eba46ec.tar.gz rust-d082ff4c04c09e855d7ea55e0c9deda05eba46ec.zip | |
Rollup merge of #144478 - joshtriplett:doc-code-formatting-prep, r=Amanieu
Improve formatting of doc code blocks We don't currently apply automatic formatting to doc comment code blocks. As a result, it has built up various idiosyncracies, which make such automatic formatting difficult. Some of those idiosyncracies also make things harder for human readers or other tools. This PR makes a few improvements to doc code formatting, in the hopes of making future automatic formatting easier, as well as in many cases providing net readability improvements. I would suggest reading each commit separately, as each commit contains one class of changes.
Diffstat (limited to 'library/std/src')
| -rw-r--r-- | library/std/src/path.rs | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/library/std/src/path.rs b/library/std/src/path.rs index d9c34d4fa04..055e7f81480 100644 --- a/library/std/src/path.rs +++ b/library/std/src/path.rs @@ -3259,8 +3259,8 @@ impl Path { /// /// # Examples /// - #[cfg_attr(unix, doc = "```no_run")] - #[cfg_attr(not(unix), doc = "```ignore")] + /// ```rust,no_run + /// # #[cfg(unix)] { /// use std::path::Path; /// use std::os::unix::fs::symlink; /// @@ -3268,6 +3268,7 @@ impl Path { /// symlink("/origin_does_not_exist/", link_path).unwrap(); /// assert_eq!(link_path.is_symlink(), true); /// assert_eq!(link_path.exists(), false); + /// # } /// ``` /// /// # See Also |
