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

remove standard library information from the Rust manual #11794

Closed
thestinger opened this issue Jan 25, 2014 · 4 comments · Fixed by #23285
Closed

remove standard library information from the Rust manual #11794

thestinger opened this issue Jan 25, 2014 · 4 comments · Fixed by #23285

Comments

@thestinger
Copy link
Contributor

I think this should be a language specification, and should avoid describing the library. The language semantics and grammar are a much saner scope to cover than the entire standard library. Implementation details like the standard library's choice of allocator are even more out of place.

@brson
Copy link
Contributor

brson commented Jan 26, 2014

Generally agree with this, though I think the language's interface to the library (intrinsics, lang items, possibly built-in syntax extensions) is in scope, but non-normative (unstable).

@brson
Copy link
Contributor

brson commented Jan 26, 2014

I don't know what parts of std are described in the manual, having not read it in a long time.

@thestinger
Copy link
Contributor Author

@brson: I opened this based on it describing the runtime's memory allocation as using malloc and free. It's not actually a guarantee we provide, and I find it way out of scope of the manual.

I think it would be a good idea to cover intrinsics and lang items there too. However, we can probably get rid of the built-in syntax extensions as a language feature now that they can be dynamically loaded. It might need some tweaking to make it an invisible change to users of the standard library.

@steveklabnik
Copy link
Member

We now say

This document also does not serve as a reference to the standard library included in the language distribution. Those libraries are documented separately by extracting documentation attributes from their source code.

We do still mention malloc and free, but isn't that now true?

I'd love some clarity here.

steveklabnik added a commit to steveklabnik/rust that referenced this issue Mar 16, 2015
alexcrichton added a commit to alexcrichton/rust that referenced this issue Mar 27, 2015
Fixes rust-lang#11794

I mostly removed superflous examples which use the standard library.

I have one more quesiton here though: threads. They're mostly a library thing, at this point, right?
dlrobertson pushed a commit to dlrobertson/rust that referenced this issue Nov 29, 2018
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 a pull request may close this issue.

3 participants