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.

Sign up for GitHub

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

Jump to bottom

Doc and rustdoc cross-document cross-references #12554

Closed
brson opened this issue Feb 26, 2014 · 1 comment
Closed

Doc and rustdoc cross-document cross-references #12554

brson opened this issue Feb 26, 2014 · 1 comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@brson
Copy link
Contributor

brson commented Feb 26, 2014

Right now every piece of documentation we have is self-contained, without an easy way to write hyperlinks between them. As we ramp up our documentation efforts it's important that we be able to link our docs together.

I'm thinking the first step is to unify our pandoc and rustdoc toolchains (#11392), then teach rustdoc some way to do links between documents.
alexcrichton added a commit to alexcrichton/rust that referenced this issue Mar 16, 2014
@alexcrichton
rustdoc: Implement cross-crate searching
235b6c3 
A major discoverability issue with rustdoc is that all crates have their
documentation built in isolation, so it's difficult when looking at the
documentation for libstd to learn that there's a libcollections crate with a
HashMap in it.

This commit moves rustdoc a little closer to improving the multiple crate
experience. This unifies all search indexes for all crates into one file so all
pages share the same search index. This allows searching to work across crates
in the same documentation directory (as the standard distribution is currently
built).

This strategy involves updating a shared file amongst many rustdoc processes, so
I implemented a simple file locking API for handling synchronization for updates
to the shared files.

cc rust-lang#12554
@alexcrichton alexcrichton mentioned this issue Mar 16, 2014
Closed
alexcrichton added a commit to alexcrichton/rust that referenced this issue Mar 18, 2014
@alexcrichton
rustdoc: Implement cross-crate searching
7da1d66 
A major discoverability issue with rustdoc is that all crates have their
documentation built in isolation, so it's difficult when looking at the
documentation for libstd to learn that there's a libcollections crate with a
HashMap in it.

This commit moves rustdoc a little closer to improving the multiple crate
experience. This unifies all search indexes for all crates into one file so all
pages share the same search index. This allows searching to work across crates
in the same documentation directory (as the standard distribution is currently
built).

This strategy involves updating a shared file amongst many rustdoc processes, so
I implemented a simple file locking API for handling synchronization for updates
to the shared files.

cc rust-lang#12554
alexcrichton added a commit to alexcrichton/rust that referenced this issue Mar 18, 2014
@alexcrichton
rustdoc: Implement cross-crate searching
848f7b7 
A major discoverability issue with rustdoc is that all crates have their
documentation built in isolation, so it's difficult when looking at the
documentation for libstd to learn that there's a libcollections crate with a
HashMap in it.

This commit moves rustdoc a little closer to improving the multiple crate
experience. This unifies all search indexes for all crates into one file so all
pages share the same search index. This allows searching to work across crates
in the same documentation directory (as the standard distribution is currently
built).

This strategy involves updating a shared file amongst many rustdoc processes, so
I implemented a simple file locking API for handling synchronization for updates
to the shared files.

cc rust-lang#12554
@steveklabnik
Copy link
Member

This is not likely to get fixed anytime soon, as Markdown doesn't have any kind of standard for how to mark up something like this. As it would be a pretty big extension / change, I'd imagine this would go through the RFC process, since Rustdoc is part of the Rust distribution, and so I'm going to give it a close here. In practice, writing manual links leads to breakgage sometimes, but it's not too hard to fix, and we have other bugs open to try to and keep up with 404s more generally.

bors added a commit to rust-lang-ci/rust that referenced this issue Jul 25, 2022
@bors
Auto merge of rust-lang#12554 - XFFXFF:fix_11959, r=Veykril
7322a98 
fix: local items should not be completed in parent signature

fixes rust-lang#11959

> We get a Bar completion for the following snippet which is wrong as the item is not visible in that position.
> ``` rust
> fn foo() -> $0 {
>    struct Bar;
> }
> ```

I investigated the problem and found that the scope of the cursor offset, also `CompletionContext.scope` is the body of the function
flip1995 pushed a commit to flip1995/rust that referenced this issue Apr 4, 2024
@bors
Auto merge of rust-lang#12554 - Kobzol:assigning-clones-unspecified, …
ca6a647 
…r=blyxyas

Change applicability of `assigning_clones` to `Unspecified`

Before we deal with rust-lang/rust-clippy#12473 and the borrow checker errors, I think that it would be better to downgrade this lint, since it can break code.

changelog: Change the applicability of `assigning_clones` to `Unspecified`

r? `@blyxyas`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@steveklabnik @brson