Use Self in docs when possible
#77079
Conversation
rustbot
added
C-enhancement
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
| /// *self = BooleanVector(self.0 | ||
| /// .iter() | ||
| /// .zip(rhs.0.iter()) | ||
| /// .map(|(x, y)| *x && *y) | ||
| /// .collect()); | ||
| /// *self = Self(self.0 | ||
| /// .iter() | ||
| /// .zip(rhs.0.iter()) | ||
| /// .map(|(x, y)| *x && *y) | ||
| /// .collect()); |
There was a problem hiding this comment.
rustfmt continues to disappoint me in every way 😢
|
Looks like it's already passing. @bors r+ rollup |
|
📌 Commit ec4e9cd has been approved by |
bors
added
S-waiting-on-bors
|
Would this be good? In the docs it is hard to identify what If it is in docs it may be clearer to current reader but when the user write it in this way and there are multiple implementations, there may be an issue I mentioned above. |
|
@pickfire this is in doc-tests, so the types will still be shown in the documentation itself. |
|
In doc tests blocks and functions are usually very short and contained so I don't think this is going to be a problem. |
Yes, I know doctests have less of this issue but it encourages others to write it this way, which in turn make the ecosystems' docs harder to read. |
…as-schievink Rollup of 15 pull requests Successful merges: - rust-lang#75438 (Use adaptive SVG favicon for rustdoc like other rust sites) - rust-lang#76304 (Make delegation methods of `std::net::IpAddr` unstably const) - rust-lang#76724 (Allow a unique name to be assigned to dataflow graphviz output) - rust-lang#76978 (Documented From impls in std/sync/mpsc/mod.rs) - rust-lang#77044 (Liballoc bench vec use mem take not replace) - rust-lang#77050 (Typo fix: "satsify" -> "satisfy") - rust-lang#77074 (add array::from_ref) - rust-lang#77078 (Don't use an if guard to check equality with a constant) - rust-lang#77079 (Use `Self` in docs when possible) - rust-lang#77081 (Merge two almost identical match arms) - rust-lang#77121 (Updated html_root_url for compiler crates) - rust-lang#77136 (Suggest `const_mut_refs`, not `const_fn` for mutable references in `const fn`) - rust-lang#77160 (Suggest `const_fn_transmute`, not `const_fn`) - rust-lang#77164 (Remove workaround for deref issue that no longer exists.) - rust-lang#77165 (Followup to rust-lang#76673) Failed merges: r? `@ghost`
Fixes #76542.
I used
rg '\s*//[!/]\s+fn [\w_]+\(&?self, ' .inlibrary/to find instances, I found some with that and some by manually checking.@rustbot modify labels: C-enhancement T-doc