Advertise Vec in LinkedList docs #38297

matklad · 2016-12-11T11:26:44Z

Hi! We already advise to use Vec instead of LinkedList in the top-level collections documentation. But I think it may be missed by someone who just directly finds LinkedList.

What do you feel about advertising Vec directly in LinkedList docs as well?

matklad · 2016-12-11T19:03:28Z

Question: how should I cross-link the docs? Relative paths won't work for LinkedList structure, because it is visible as both collections::LinkedList and collections::linked_list::LinkedList.

steveklabnik · 2016-12-12T19:11:21Z

Question: how should I cross-link the docs?

This is one area where we can't 😦

ollie27 · 2016-12-13T11:21:00Z

You've hit #32130. The options are to leave the links out for now or add more exceptions to linkchecker here.

GuillaumeGomez · 2016-12-13T13:12:10Z

src/libcollections/linked_list.rs

+//! in constant time.
+//!
+//! Almost always it is better to use [`Vec`](../vec/struct.Vec.html) or
+//! [`VecDeque`](./vec_deque/struct.VecDeque.html) instead of `LinkedList`.


Since this is a module-level doc comment, I guess LinkedList should have an url.

GuillaumeGomez · 2016-12-13T13:12:47Z

src/libcollections/linked_list.rs

+/// The `LinkedList` allows pushing and popping elements at either end
+/// in constant time.
+///
+/// Almost always it is better to use [`Vec`](../vec/struct.Vec.html) or


We don't use this linking syntax, we use:

text long text etc [link] blabla blablabla [link]: url

GuillaumeGomez · 2016-12-13T13:12:56Z

src/libcollections/linked_list.rs

+/// in constant time.
+///
+/// Almost always it is better to use [`Vec`](../vec/struct.Vec.html) or
+/// [`VecDeque`](./vec_deque/struct.VecDeque.html) instead of `LinkedList`.


Same comment.

GuillaumeGomez · 2016-12-13T13:13:09Z

src/libcollections/linked_list.rs

+//! in constant time.
+//!
+//! Almost always it is better to use [`Vec`](../vec/struct.Vec.html) or
+//! [`VecDeque`](./vec_deque/struct.VecDeque.html) instead of `LinkedList`.


Same comment.

GuillaumeGomez · 2016-12-13T13:13:14Z

src/libcollections/linked_list.rs

+//! The `LinkedList` allows pushing and popping elements at either end
+//! in constant time.
+//!
+//! Almost always it is better to use [`Vec`](../vec/struct.Vec.html) or


Same comment.

matklad · 2016-12-14T12:27:55Z

So let's use links in the module docs, because they always work, and let's avoid links on the struct directly, because it is reexported.

GuillaumeGomez · 2016-12-14T17:02:22Z

std/collections/linked_list/index.html:57: broken link - std/collections/linked_list/struct.LinkedList
collections/linked_list/index.html:56: broken link - vec/struct.Vec.html
collections/linked_list/index.html:57: broken link - collections/linked_list/struct.LinkedList

matklad · 2016-12-16T20:10:24Z

Linking to Vec is also impossible, because there are collections and std::collections. Should be good now?

GuillaumeGomez · 2016-12-16T21:57:10Z

src/libcollections/linked_list.rs

+/// The `LinkedList` allows pushing and popping elements at either end
+/// in constant time.
+///
+/// Almost always it is better to use `Vec` or `VecDeque` instead of


Why not linking to VecDeque here? You did it just above.

LinkedList struct is visible as both https://doc.rust-lang.org/std/collections/struct.LinkedList.html and https://doc.rust-lang.org/std/collections/linked_list/struct.LinkedList.html, so I can't craft a relative link that will be valid in both cases.

but for the linked_list module I can do this.

matklad · 2016-12-20T10:26:28Z

@GuillaumeGomez anything else to clean up here?

GuillaumeGomez · 2016-12-21T16:41:18Z

Nothing, thanks!

@bors: r+ rollup

bors · 2016-12-21T16:41:19Z

📌 Commit 71de148 has been approved by GuillaumeGomez

bors · 2016-12-22T00:29:59Z

⌛ Testing commit 71de148 with merge d365d32...

bors · 2016-12-22T00:32:37Z

💔 Test failed - auto-mac-32-opt

steveklabnik · 2016-12-22T21:39:28Z

@bors: retry

@steveklabnik

…r=GuillaumeGomez Advertise Vec in LinkedList docs r? @steveklabnik Hi! We already [advise](https://doc.rust-lang.org/std/collections/#use-a-linkedlist-when) to use `Vec` instead of `LinkedList` in the top-level collections documentation. But I think it may be missed by someone who just directly finds `LinkedList`. What do you feel about advertising `Vec` directly in `LinkedList` docs as well?

Rollup of 14 pull requests - Successful merges: #37956, #38013, #38297, #38480, #38497, #38502, #38505, #38513, #38521, #38549, #38554, #38557, #38568, #38572 - Failed merges:

rust-highfive assigned steveklabnik Dec 11, 2016

matklad force-pushed the linked-lists-are-not-cool branch from 479923f to 8a4a8ca Compare December 11, 2016 16:47

GuillaumeGomez requested changes Dec 13, 2016

View reviewed changes

matklad force-pushed the linked-lists-are-not-cool branch 2 times, most recently from 1065395 to 8ea3d32 Compare December 14, 2016 12:26

matklad force-pushed the linked-lists-are-not-cool branch 2 times, most recently from d46374d to 1c868ee Compare December 16, 2016 07:06

Advertise Vec in LinkedList docs

71de148

matklad force-pushed the linked-lists-are-not-cool branch from 1c868ee to 71de148 Compare December 16, 2016 07:47

GuillaumeGomez reviewed Dec 16, 2016

View reviewed changes

GuillaumeGomez approved these changes Dec 21, 2016

View reviewed changes

steveklabnik mentioned this pull request Dec 24, 2016

Rollup of 14 pull requests #38594

Merged

bors merged commit 71de148 into rust-lang:master Dec 25, 2016

matklad deleted the linked-lists-are-not-cool branch July 9, 2019 12:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Advertise Vec in LinkedList docs #38297

Advertise Vec in LinkedList docs #38297

matklad commented Dec 11, 2016

matklad commented Dec 11, 2016

steveklabnik commented Dec 12, 2016

ollie27 commented Dec 13, 2016

GuillaumeGomez Dec 13, 2016

GuillaumeGomez Dec 13, 2016

GuillaumeGomez Dec 13, 2016

GuillaumeGomez Dec 13, 2016

GuillaumeGomez Dec 13, 2016

matklad commented Dec 14, 2016

GuillaumeGomez commented Dec 14, 2016

matklad commented Dec 16, 2016

GuillaumeGomez Dec 16, 2016

matklad Dec 17, 2016 •

edited

Loading

matklad commented Dec 20, 2016

GuillaumeGomez commented Dec 21, 2016

bors commented Dec 21, 2016

bors commented Dec 22, 2016

bors commented Dec 22, 2016

steveklabnik commented Dec 22, 2016

Advertise Vec in LinkedList docs #38297

Advertise Vec in LinkedList docs #38297

Conversation

matklad commented Dec 11, 2016

matklad commented Dec 11, 2016

steveklabnik commented Dec 12, 2016

ollie27 commented Dec 13, 2016

GuillaumeGomez Dec 13, 2016

Choose a reason for hiding this comment

GuillaumeGomez Dec 13, 2016

Choose a reason for hiding this comment

GuillaumeGomez Dec 13, 2016

Choose a reason for hiding this comment

GuillaumeGomez Dec 13, 2016

Choose a reason for hiding this comment

GuillaumeGomez Dec 13, 2016

Choose a reason for hiding this comment

matklad commented Dec 14, 2016

GuillaumeGomez commented Dec 14, 2016

matklad commented Dec 16, 2016

GuillaumeGomez Dec 16, 2016

Choose a reason for hiding this comment

matklad Dec 17, 2016 • edited Loading

Choose a reason for hiding this comment

matklad commented Dec 20, 2016

GuillaumeGomez commented Dec 21, 2016

bors commented Dec 21, 2016

bors commented Dec 22, 2016

bors commented Dec 22, 2016

steveklabnik commented Dec 22, 2016

matklad Dec 17, 2016 •

edited

Loading