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

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

Closed
camelid opened this issue Nov 1, 2020 · 4 comments
Closed

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

camelid opened this issue Nov 1, 2020 · 4 comments
Labels

Comments

@camelid
Copy link
Member

camelid commented Nov 1, 2020

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
Copy link
Member

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
Copy link
Member Author

camelid commented Nov 1, 2020

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
Copy link
Member

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

@JohnTitor
Copy link
Member

JohnTitor commented Nov 5, 2020

So, I'm going to close this as:

  1. Some sections should have "serious errors" e.g. Adjust Vec to build on stable Rust #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 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants