Skip to content

The Rust Reference lacks a table of contents #17505

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
Closed
tomjakubowski opened this issue Sep 24, 2014 · 8 comments
Closed

The Rust Reference lacks a table of contents #17505

tomjakubowski opened this issue Sep 24, 2014 · 8 comments
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@tomjakubowski
Copy link
Contributor

The full table of contents in the manual (v0.11)1 made it much easier to navigate than the new Rust Reference. A long, highly structured document like the Reference needs a full table of contents to be most useful.

1 the kinda ugly line spacing bug was later fixed I'm pretty sure.
@steveklabnik
Copy link
Member

👍 for sure.

@nodakai
Copy link
Contributor

nodakai commented Sep 24, 2014

I really miss the detailed TOC of the language reference. Cf., eg.

It also served me as an index.

@huonw
Copy link
Member

huonw commented Sep 24, 2014

The sections are all there, just hidden by CSS; the old manual has some custom CSS to override this and display them all.

@huonw huonw added A-docs E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Nov 4, 2014
@adrientetar
Copy link
Contributor

Yes it had some CSS injected in the Makefile via --include-in-header (just a pointer if someone wants to take this on).
The include file is still present: https://github.com/rust-lang/rust/blob/master/src/doc/full-toc.inc

It's just a matter of adding it back to the Makefile.

@gamazeps
Copy link
Contributor

gamazeps commented Nov 4, 2014

Thanks for the pointer, I'll look at it tonight.

But if someone wants to tackle it before, feel free :p

@gamazeps
Copy link
Contributor

gamazeps commented Nov 6, 2014

@adrientetar it's stilll called in the makefile, I'll look at the diffs to see what changed :/

@adrientetar
Copy link
Contributor

@gamazeps At lines 36-37, rename RUSTDOC_{…}_rust to RUSTDOC_{…}_reference, that’s because rust.md was renamed to reference.md.
Also can you remove rust at line 31? Steve didn’t remove it when he changed the Makefile.

@steveklabnik
Copy link
Member

Ahhhhh so that's what it is. Whoops!

Sent from my iPhone

On Nov 6, 2014, at 21:33, Adrien Tétar notifications@github.com wrote:

@gamazeps At lines 36-37, rename RUSTDOC_{…}rust to RUSTDOC{…}_reference, that’s because rust.md was renamed to reference.md.
Also can you remove rust at line 31? Steve didn’t remove it when he changed the Makefile.

—
Reply to this email directly or view it on GitHub.

@gamazeps gamazeps mentioned this issue Nov 6, 2014
Closed
bors added a commit that referenced this issue Nov 8, 2014
@bors
auto merge of #18724 : gamazeps/rust/toc, r=alexcrichton
c437fcf 
Using @adrientetar advices

Closes #17505
@bors bors closed this as completed in 9e5b283 Nov 8, 2014
lnicola pushed a commit to lnicola/rust that referenced this issue Jul 11, 2024
@bors
Auto merge of rust-lang#17505 - ShoyuVanilla:issue-17199, r=Veykril
fde5564 
Use proper `ImplTraits` in `insert_inference_vars_for_impl_trait`

Fixes rust-lang#17199 and fixes rust-lang#17403

In the previous implementation, I passed `rpits` as a function parameter and used `idx` of `ImplTraitId` for indexing `ImplTrait`.

https://github.com/rust-lang/rust-analyzer/blob/4e836c622a7bdab41be8e82733dd9fe40af128b2/crates/hir-ty/src/infer.rs#L881-L887

But that `idx` is rather a "local" one, so in the cases like mentioned issues, the async function that can be expanded roughly as

```rust
type TypeAlias = impl Something;
fn expanded_async() -> impl Future<Output = TypeAlias> { ... }
```

there are two bundles of `ImplTraits`; one for the `impl Future` and the other one for `TypeAlias`.
So using `idx` with `rpits` returns `ImplTrait` for `impl Future` even if we are asking for `TypeAlias` and this caused a stack overflow.

This PR is a fix for that implementation miss 😅
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Guide: Puts the toc again in the doc gamazeps/rust
6 participants
@steveklabnik @nodakai @tomjakubowski @huonw @adrientetar @gamazeps