search

rust-lang / nomicon

The Dark Arts of Advanced and Unsafe Rust Programming
https://doc.rust-lang.org/nomicon/
Apache License 2.0
1.85k stars 268 forks source link

Is the Nomicon still a "draft document"? #243

Closed camelid closed 3 years ago

camelid commented 4 years ago

The README says:

NOTE: This is a draft document, and may contain serious errors

[...]

Contributing

Given that the Nomicon is still in a draft state, we'd love your help! Please feel free to open issues about anything, and send in PRs for things you'd like to fix or change. If your change is large, please open an issue first, so we can make sure that it's something we'd accept before you go through the work of getting a PR together.

But this comment is 4 years old. Is it still true that the Nomicon is a draft and may contain serious errors?

JohnTitor commented 4 years ago

Since that comment, we've eventually added a lot of sections but now some are outdated. And we still have some TODOs so at least we could say it's "incomplete" (you could also find the issues that need some re-writing, refining, etc.).

camelid commented 4 years ago

Although I think a lot of Rust documentation is technically “incomplete”: the Reference and the rustc-dev-guide are the ones I’m thinking of.

JohnTitor commented 4 years ago

Though I'm not sure if it's worth removing that message at all.

JohnTitor commented 3 years ago

So, I'm going to close this as:

  1. Some sections should have "serious errors" e.g. #223.
  2. And some other sections should be outdated (see the issue tracker).
  3. We don't have enough maintainers to keep the nomicon complete.

Thus, that message isn't lying and I don't think it gives the folks the wrong impression. If someone wants to remove it, however, feel free to comment here. I'm open to discuss (and even remove) it :)