Skip to content

Comments with /*********... are handled strangely #9425

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

Closed
huonw opened this issue Sep 23, 2013 · 1 comment
Closed

Comments with /*********... are handled strangely #9425

huonw opened this issue Sep 23, 2013 · 1 comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@huonw
Copy link
Member

huonw commented Sep 23, 2013

E.g. in extra::arc there is

/****************************************************************************
 * Immutable Arc
 ****************************************************************************/

/// An atomically reference counted wrapper for shared immutable state.
pub struct Arc<T> { priv x: UnsafeArc<T> }

which results in this HTML:

<hr>
<ul>
<li>Immutable Arc *************************************************************************** An atomically reference counted wrapper for shared immutable state.</li>
</ul>

(Appearing here at time of filing.)

@alexcrichton
Copy link
Member

I think that in general doc-comment stripping needs to be more robust.

I believe that solving this issue would also solve #9417

alexcrichton added a commit to alexcrichton/rust that referenced this issue Sep 23, 2013
There is less implicit removal of various comment styles, and it also removes
extraneous stars occasionally found in docblock comments. It turns out that the
bug for getops was just a differently formatted block.

Closes rust-lang#9425
Closes rust-lang#9417
alexcrichton added a commit to alexcrichton/rust that referenced this issue Sep 24, 2013
There is less implicit removal of various comment styles, and it also removes
extraneous stars occasionally found in docblock comments. It turns out that the
bug for getops was just a differently formatted block.

Closes rust-lang#9425
Closes rust-lang#9417
flip1995 pushed a commit to flip1995/rust that referenced this issue Sep 9, 2022
fix wording for `derivable_impls`

While looking at the explanation as to why this lint was not automatically applicable, found the explanation a bit clunky grammatically.

 Feel free to close if you consider the wording was correct in the first place.

changelog: none
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants