Skip to content

Rustdoc can generate wrong macro_rules! syntax #60543

Closed
Closed
Rustdoc can generate wrong macro_rules! syntax#60543
Labels
A-macrosArea: All kinds of macros (custom derive, macro_rules!, proc macros, ..)C-bugCategory: This is a bug.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Description

@jonas-schievink
jonas-schievink
opened on May 4, 2019

Example: https://docs.rs/pkg-version/0.1.0/pkg_version/macro.pkg_version_minor.html

The source code looks like this:

#[proc_macro_hack]
pub use pkg_version_impl::pkg_version_minor;

The rustdoc output looks like this:

macro_rules! pkg_version_minor {
    #[proc_macro_hack] => { ... };
}

Now I'm not entirely sure how #[proc_macro_hack] works, but I don't think rustdoc should ever produce... this? The matcher is syntactically invalid, so this should never really happen.

Perhaps related to #45939, but I'm not sure.

Activity

  1. jonas-schievink
    added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    A-macrosArea: All kinds of macros (custom derive, macro_rules!, proc macros, ..)
    C-bugCategory: This is a bug.
    on May 4, 2019
  2. ogoffart
    added a commit that references this issue on Jun 2, 2020

    Small doc fixup to workaround rustdoc bug

    9c3dbe1

  3. dtolnay commented on Dec 26, 2021

    @dtolnay
    dtolnay
    on Dec 26, 2021
    Member

    Fixed in nightly-2021-07-06, likely by #86282.

  4. dtolnay
    closed this as completedon Dec 26, 2021

  5. dtolnay commented on Dec 26, 2021

    @dtolnay
    dtolnay
    on Dec 26, 2021
    Member

    The new rustdoc shows:

    macro_rules! pkg_version_minor {
    ($($proc_macro : tt) *) => { ... };
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-macrosArea: All kinds of macros (custom derive, macro_rules!, proc macros, ..)C-bugCategory: This is a bug.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions