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

Add link to the Vec<T> API documentation #2249

Merged
merged 1 commit into from
Jul 27, 2020

Conversation

Vinnl
Copy link
Contributor

@Vinnl Vinnl commented Feb 9, 2020

I was looking for this link while working my way through the book. I'm not sure if this is the correct way to link to API documentation (as its not included in this repo), but it looks good to me.

@steveklabnik
Copy link
Member

I think this would be fine to add, but I'm not sure we've decided a like, policy for when to link and when not to. Carol, what do you think?

@tannakartikey
Copy link

tannakartikey commented Apr 19, 2020

@steveklabnik @carols10cents it would help if there was a policy. I was going through the docs today while I thought that at some places links were needed and found this issue.

For example, I am going through Generating a secret number docs. In the first paragraph itself (at the end) the link of "rand crate" is given.

After a few scrolls, I was reading "Generating a Random Number" where rand is mentioned a few times and methods like rand::thread_rng but there are no links. I had to search and find the docs.

And just a suggestion for the policy. How about giving links to all the methods even though they are repeating provided we can automate the process while building docs.
Let's assume if we were able to achieve that then reading thorough the docs will not be quite easy on eyes. To solve that we can remove the traditional hyperlink styling (blue color and underline) and keep it as it is now (without the hyperlink).

I can contribute in any way according to the policy.

Copy link
Member

@carols10cents carols10cents left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with this; I think I'm fine anywhere someone wishes there was a link. I don't think we're going to transfer these to written-out URLs in print though.

@carols10cents carols10cents merged commit 1ef6872 into rust-lang:master Jul 27, 2020
Manishearth added a commit to Manishearth/rust that referenced this pull request Aug 5, 2020
Update books

## reference

7 commits in b329ce37424874ad4db94f829a55807c6e21d2cb..c9b2736a059469043177e1e4ed41a55d7c63ac28
2020-07-20 08:54:08 -0700 to 2020-08-03 03:34:03 -0700
- Fix documented build output path. (rust-lang/reference#870)
- Update token usage table. (rust-lang/reference#868)
- Allow trait inner attributes (rust-lang/reference#864)
- patterns.md - add word "underscore" to _ paragraph (rust-lang/reference#865)
- Drive-by mention unsafe fn closure coercion (rust-lang/reference#802)
- grammar: Change "For awhile" to "For a while" (rust-lang/reference#857)
- Added Unpin to list of Auto Traits (rust-lang/reference#854)

## book

7 commits in a914f2c7e5cdb771fa465de142381a51c53b580e..363293c1c5ce9e84ea3935a5e29ce8624801208a
2020-07-21 09:20:05 -0500 to 2020-08-03 15:56:30 -0500
- replace commas with m-dashes to improve readability of chapter 4.1 (rust-lang/book#2419)
- Update TOML link to official website (rust-lang/book#2411)
- Add github repo link (rust-lang/book#2265)
- Remove the version number entirely so we can stop updating it
- Add link to the `Vec&lt;T&gt;` API documentation (rust-lang/book#2249)
- link to stdlib atomic docs (rust-lang/book#2361)
- mdbook version used is now 0.4.x (rust-lang/book#2410)

## rust-by-example

1 commits in 229c6945a26a53a751ffa4f9cb418388c00029d3..2e9271981adc32613365810f3428334c07095215
2020-07-06 10:13:15 -0300 to 2020-07-27 13:39:16 -0500
- Replaced "princess" with "royal" (rust-lang/rust-by-example#1363)

## embedded-book

1 commits in 94d9ea8460bcbbbfef1877b47cb930260b5849a7..b5256448a2a4c1bec68b93c0847066f92f2ff5a9
2020-07-05 14:17:40 +0000 to 2020-07-24 23:09:29 +0000
- Update c-with-rust.md  (rust-embedded/book#256)
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Aug 5, 2020
Update books

## reference

7 commits in b329ce37424874ad4db94f829a55807c6e21d2cb..c9b2736a059469043177e1e4ed41a55d7c63ac28
2020-07-20 08:54:08 -0700 to 2020-08-03 03:34:03 -0700
- Fix documented build output path. (rust-lang/reference#870)
- Update token usage table. (rust-lang/reference#868)
- Allow trait inner attributes (rust-lang/reference#864)
- patterns.md - add word "underscore" to _ paragraph (rust-lang/reference#865)
- Drive-by mention unsafe fn closure coercion (rust-lang/reference#802)
- grammar: Change "For awhile" to "For a while" (rust-lang/reference#857)
- Added Unpin to list of Auto Traits (rust-lang/reference#854)

## book

7 commits in a914f2c7e5cdb771fa465de142381a51c53b580e..363293c1c5ce9e84ea3935a5e29ce8624801208a
2020-07-21 09:20:05 -0500 to 2020-08-03 15:56:30 -0500
- replace commas with m-dashes to improve readability of chapter 4.1 (rust-lang/book#2419)
- Update TOML link to official website (rust-lang/book#2411)
- Add github repo link (rust-lang/book#2265)
- Remove the version number entirely so we can stop updating it
- Add link to the `Vec&lt;T&gt;` API documentation (rust-lang/book#2249)
- link to stdlib atomic docs (rust-lang/book#2361)
- mdbook version used is now 0.4.x (rust-lang/book#2410)

## rust-by-example

1 commits in 229c6945a26a53a751ffa4f9cb418388c00029d3..2e9271981adc32613365810f3428334c07095215
2020-07-06 10:13:15 -0300 to 2020-07-27 13:39:16 -0500
- Replaced "princess" with "royal" (rust-lang/rust-by-example#1363)

## embedded-book

1 commits in 94d9ea8460bcbbbfef1877b47cb930260b5849a7..b5256448a2a4c1bec68b93c0847066f92f2ff5a9
2020-07-05 14:17:40 +0000 to 2020-07-24 23:09:29 +0000
- Update c-with-rust.md  (rust-embedded/book#256)
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

Successfully merging this pull request may close these issues.

4 participants