Skip to content
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

Feature request: being able to follow internal links in the documentation #9708

Closed
irevoire opened this issue Jul 27, 2021 · 2 comments
Closed

Comments

@irevoire
Copy link

Hello,

It would be great if we could follow links in the code documentation / comments in the same way rustdoc handle it.
For example for this snippet of code:

#[async_trait::async_trait]
#[cfg_attr(test, automock)]
pub trait DumpActorHandle {
    /// Start the creation of a dump
    /// Implementation: [handle_impl::DumpActorHandleImpl::create_dump]
    async fn create_dump(&self) -> Result<DumpInfo>;

    /// Return the status of an already created dump
    /// Implementation: [handle_impl::DumpActorHandleImpl::dump_info]
    async fn dump_info(&self, uid: String) -> Result<DumpInfo>;
}

I would like to put my cursor on the handle_impl::DumpActorHandleImpl::create_dump and jump to the definition.

@Veykril
Copy link
Member

Veykril commented Jul 27, 2021

That is actually already implemented, but our doc path resolution isn't fully working yet(I'm currently trying to fix that up) which is why it doesn't work in your case here. Basically we cant resolve associated items in there yet.

@Veykril
Copy link
Member

Veykril commented Jul 27, 2021

As such I'll close this as an indirect dupe of #9694

@Veykril Veykril closed this as completed Jul 27, 2021
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

No branches or pull requests

2 participants