Comments (4)
Yes, this would be great. One of the things I have been wondering is how to link to functions -- or maybe even snippets -- in the Rust source. I'd like it if the book were moved into the Rust repository so that changes to the Rust source would not build if they broke the book; but in the meantime, I suppose a "simple" solution would be to have the rustdoc for the compiler posted somewhere, which would give us the ability to link to methods/functions/etc.
from rustc-dev-guide.
I've got a copy of the internal docs which are recompiled and uploaded daily. Would it be worth asking people to link to that?
All I did was translate an old shell script of mine into Rust and then set up cron
to make sure the program gets run while I'm asleep, so if the tool can help here feel free to use/fork it. I remember talk of making a better solution, but I don't think anything came of it.
from rustc-dev-guide.
@Michael-F-Bryan maybe we could put it on rust-lang-nursery or forge or some such?
So long as we are an external guide, of course, we have to think about a policy to detect rot -- i.e., compiler changes, we have to adapt.
from rustc-dev-guide.
Still, I wonder how hard it is to get that "better solution" up and going. Maybe an excuse to learn something about infra.
from rustc-dev-guide.
Related Issues (20)
- Date Reference Triage for 2023-12
- Example in "Getting diagnostic through `rustc_interface`" is outdated and meaningless
- Modifying AST
- Date Reference Triage for 2024-01
- Getting Started page "help-wanted-search" link goes to a 404 Github page HOT 2
- Broken link in Canonicalization chapter HOT 3
- In Compiler Architecture section, state explicitly you assume the compiler do not change between build
- Clarify what is a UI test HOT 4
- Clarify why Salsa is mentioned HOT 2
- Not clear sentence "Eager expansion generally performs a subset of the things that lazy (normal) expansion does."
- In macro expansion section, explains why import and collections must be redone
- Clarify "call site hierarchy" in macro
- Date Reference Triage for 2024-02 HOT 1
- Appendix D: Compiler Lecture Series: Update
- HIR documentation is outdated
- Diagnostic/subdiagnostic example struct /struct field fluent slugs outdated
- Date Reference Triage for 2024-03 HOT 1
- Date Reference Triage for 2024-04 HOT 1
- Automated Dead Link Detection HOT 1
- Guide answers "what" but not "why" and "how" for codegen tests
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rustc-dev-guide.