Skip to content

Autocomplete cargo doc paths/links to types in doc comment #4759

@chinedufn

Description

@chinedufn

I've opened this same issue in intellij-rust, but figured I'd also open it here since I'm interested in both tools.

Here's the copy pasted issue:


If you write something like the following in a doc comment

/// An error returned by [`RefCell::try_borrow`](struct.RefCell.html#method.try_borrow).
#[stable(feature = "try_borrow", since = "1.13.0")]
pub struct BorrowError {
    _private: (),
}

The struct.RefCell.html#method.try_borrow your documentation site will link to the try_borrow method when you click on the RefCell::try_borrow link.

Since the naming convention for pages / links within a cargo doc generated site is consistent - could intellij-rust support autocomplete for these links?

This would make it much easier to write documentation that references other types/methods within your library.

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-completionautocompletionE-hardS-actionableSomeone could pick this issue up and work on it right now

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions