Skip to content

std::collections top-level docs are out of date #22550

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

Closed
Gankra opened this issue Feb 19, 2015 · 8 comments
Closed

std::collections top-level docs are out of date #22550

Gankra opened this issue Feb 19, 2015 · 8 comments
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@Gankra
Copy link
Contributor

Gankra commented Feb 19, 2015

http://doc.rust-lang.org/std/collections/#entries in particular makes reference to old method names. Wouldn't be surprised if other parts of the docs are similarly out of date. Need to do a full pass.

@Gankra Gankra added the A-docs label Feb 19, 2015
@brson brson added the E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. label Feb 20, 2015
@djmally
Copy link
Contributor

djmally commented Mar 1, 2015

I'd like to tackle this (and work on sorting out other modules in collections as well), but are there any particular method names that stick out in the link above? I combed through it and didn't find any, and all the sample code builds under the nightly from 2/26, albeit with warnings.

@djmally
Copy link
Contributor

djmally commented Mar 1, 2015

Also, very new to contributing to Rust here-- where do these pages live in the repo?

@huonw
Copy link
Member

huonw commented Mar 1, 2015

The top-level docs are the big //! comment section at the top of src/libstd/collections/mod.rs. The individual modules docs are in the various .rs files in libcollections and libstd/collections.

Feel free to ask here or on IRC (either #rust-internals or #rust-libs are appropriate channels) if you need any more help or advice! :)

@Gankra
Copy link
Contributor Author

Gankra commented Mar 1, 2015

The issue was made in reference to the linked section referring to non-existent set and take methods (now insert and remove). Didn't do a detailed comb for anything else.

@djmally
Copy link
Contributor

djmally commented Mar 2, 2015

Changes made as #22973. One other thing I noticed was that in the performance tables (http://doc.rust-lang.org/std/collections/#sequences), a number of methods are referenced that don't exist for certain collections, e.g. LinkedList doesn't implement get, insert, or remove, and VecMap doesn't implement predecessor, among other similar cases.

Not really sure what the course of action should be here: should these methods be marked somehow to show that they don't exist by that name for that collection, or should there be a note stating that the names in this table may not be exact?

@Gankra
Copy link
Contributor Author

Gankra commented Mar 2, 2015

I believe I have a quick one-liner above the table that says something to the affect of "actual methods may differ". Any methods that are missing are just "to implement".

@djmally
Copy link
Contributor

djmally commented Mar 2, 2015

I don't see anything in the section preceding the table, but I can add it in if it's not there.

@steveklabnik
Copy link
Member

Closing since #22973 was merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Development

No branches or pull requests

5 participants