Link from ARCHITECTURE.md to docs.rs and github #6695
Conversation
|
r? @Eh2406 (rust_highfive has picked a reviewer for you, use r? to override) |
|
Good idea! But for links about cargo itself, I think relative links would be better. |
|
You are right! |
ARCHITECTURE.md
Outdated
| [`Package`]: https://docs.rs/cargo/0.33.0/cargo/core/package/struct.Package.html | ||
| [`Target`]: https://docs.rs/cargo/0.33.0/cargo/core/manifest/struct.Target.html | ||
| [`PackageId`]: https://docs.rs/cargo/0.33.0/cargo/core/package_id/struct.PackageId.html | ||
| [`Resolve`]: https://docs.rs/cargo/0.33.0/cargo/core/struct.Resolve.html |
There was a problem hiding this comment.
I was thinking it would be best if these too were relative to, say, src/cargo/core/resolver/resolve.rs.
There was a problem hiding this comment.
I think rendered document at docs.rs would be more readable, and it would be more useful thanks to the cross-links between structs, methods, etc.
There was a problem hiding this comment.
Yeah, I know what you mean. Maybe then, to avoid having a stale version or the maintenance of updating the version, we should use https://docs.rs/cargo/latest/cargo/core/struct.Resolve.html?
There was a problem hiding this comment.
Maybe then, to avoid having a stale version or the maintenance of updating the version, we should use https://docs.rs/cargo/latest/cargo/core/struct.Resolve.html?
I made a silly mistake. Fixed 😄
|
LGTM. Thanks, @ordovicia. @bors r+ |
|
📌 Commit 85c5fe1 has been approved by |
Link from ARCHITECTURE.md to docs.rs and github These links should help contributors dive into Cargo internals.
|
☀️ Test successful - checks-travis, status-appveyor |
Update cargo, rls ## cargo 6 commits in 5c6aa46e6f28661270979696e7b4c2f0dff8628f..716b02cb4c7b75ce435eb06defa25bc2d725909c 2019-02-22 19:32:35 +0000 to 2019-03-02 14:23:51 +0000 - Some test/bench-related tweaks (rust-lang/cargo#6707) - Fix links to the permanent home of the edition guide. (rust-lang/cargo#6703) - HTTPS all the things (rust-lang/cargo#6614) - Cargo test quicker by not building untested examples when filtered (rust-lang/cargo#6683) - Link from ARCHITECTURE.md to docs.rs and github (rust-lang/cargo#6695) - Update how to install rustfmt (rust-lang/cargo#6696) ## rls 9 commits in 0d6f53e1a4adbaf7d83cdc0cb54720203fcb522e..6a1b5a9cfda2ae19372e0613e76ebefba36edcf5 2019-02-14 07:52:15 +0000 to 2019-03-04 20:24:45 +0000 - Update cargo and clippy. (rust-lang/rls#1388) - catch up rust-lang/rust PR#58321 (rust-lang/rls#1384) - Apply Clippy fixes (rust-lang/rls#1327) - Various cosmetic improvements (rust-lang/rls#1326) - Make test `RlsHandle` transport-agnostic (rust-lang/rls#1317) - Translate remaining tests (rust-lang/rls#1320) - Remove unnecessary #![feature]s (rust-lang/rls#1323) - Update Clippy (rust-lang/rls#1319) - Update Clippy (rust-lang/rls#1315) cc @Xanewok
Update cargo, rls, books ## cargo 10 commits in 5c6aa46e6f28661270979696e7b4c2f0dff8628f..95b45eca19ac785263fed98ecefe540bb47337ac 2019-02-22 19:32:35 +0000 to 2019-03-06 19:24:30 +0000 - Relax some rustdoc tests. (rust-lang/cargo#6721) - Include build script execution in the fingerprint. (rust-lang/cargo#6720) - part of the infrastructure for public & private dependencies in the resolver (rust-lang/cargo#6653) - Bump to 0.36.0 (rust-lang/cargo#6718) - Some test/bench-related tweaks (rust-lang/cargo#6707) - Fix links to the permanent home of the edition guide. (rust-lang/cargo#6703) - HTTPS all the things (rust-lang/cargo#6614) - Cargo test quicker by not building untested examples when filtered (rust-lang/cargo#6683) - Link from ARCHITECTURE.md to docs.rs and github (rust-lang/cargo#6695) - Update how to install rustfmt (rust-lang/cargo#6696) ## rls 9 commits in 0d6f53e1a4adbaf7d83cdc0cb54720203fcb522e..6a1b5a9cfda2ae19372e0613e76ebefba36edcf5 2019-02-14 07:52:15 +0000 to 2019-03-04 20:24:45 +0000 - Update cargo and clippy. (rust-lang/rls#1388) - catch up rust-lang/rust PR#58321 (rust-lang/rls#1384) - Apply Clippy fixes (rust-lang/rls#1327) - Various cosmetic improvements (rust-lang/rls#1326) - Make test `RlsHandle` transport-agnostic (rust-lang/rls#1317) - Translate remaining tests (rust-lang/rls#1320) - Remove unnecessary #![feature]s (rust-lang/rls#1323) - Update Clippy (rust-lang/rls#1319) - Update Clippy (rust-lang/rls#1315) cc @Xanewok ## Books See #58936 for details.
These links should help contributors dive into Cargo internals.