Skip to content

Some rustdoc manual fixes #10913

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.

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

Merged
merged 2 commits into from
Dec 13, 2013
Merged

Some rustdoc manual fixes #10913

merged 2 commits into from
Dec 13, 2013

Conversation

emberian
Copy link
Member

Clarify that it's sundown, and that we don't support magic

Doc comments are markdown, and are currently parsed with the
[sundown][sundown] library. rustdoc does not yet do any fanciness such as
referencing other items inline, like javadoc's `@see`. One exception to this
is that the first sentence will be used as the "summary" of an item in the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't the behaviour first paragraph, rather than first sentence?

@emberian
Copy link
Member Author

@huonw fixed, thanks

@kud1ing
Copy link

kud1ing commented Dec 11, 2013

Would you mind merging in #10901 ?

kud1ing and others added 2 commits December 11, 2013 06:47
The following files need to be adjusted, too (i can't do it now):
- doc/po/ja/rust.md.po
- doc/po/rust.md.pot
Clarify that it's sundown, and that we don't support magic
bors added a commit that referenced this pull request Dec 13, 2013
Clarify that it's sundown, and that we don't support magic
@bors bors closed this Dec 13, 2013
@bors bors merged commit f0867e0 into rust-lang:master Dec 13, 2013
flip1995 pushed a commit to flip1995/rust that referenced this pull request Jun 30, 2023
[`unnecessary_to_owned`]: check that the adjusted type matches target

Fixes rust-lang#10033.

Before this change, the lint would assume that removing the `.to_string()` in `f(&x.to_string())` would be ok if x is of some type that implements `Deref<Target = str>` and `f` takes a `&str`.
This turns out to not actually be ok if the `to_string` call is some method that exists on `x` directly, which happens if it implements `Display`/`ToString` itself.

changelog: [`unnecessary_to_owned`]: only lint if the adjusted receiver type actually matches
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants