about summary refs log tree commit diff
path: root/src/libstd/keyword_docs.rs
AgeCommit message (Collapse)AuthorLines
2020-07-27mv std libs to library/mark-2113/+0
2020-07-25Auto merge of #74017 - poliorcetics:where-keyword, r=jyn514bors-2/+93
Document the where keyword Partial fix of #34601 (and last PR for it 🎉). This documents the `where` keyword. @rustbot modify labels: T-doc,C-enhancement
2020-07-24Auto merge of #73645 - poliorcetics:ref-keyword, r=jyn514bors-2/+43
Document the ref keyword Partial fix for #34601. This documents the `ref` keyword with two examples, one failing to compile because the `ref` keyword is missing, and the same example fixed with the keyword inserted in the correct place. It also explains (very *very* rapidly) the differences between `&` and `ref`. I put a link to the best place I could find in the Reference but there may be something better that I didn't find.
2020-07-24Fix nits, rework the second example of select (the one deliberately failing ↵Alexis Bourget-33/+15
to compile)
2020-07-24Fix nitsAlexis Bourget-3/+3
2020-07-23Fix nitAlexis Bourget-1/+2
2020-07-23Fix nit and add link for CowAlexis Bourget-32/+8
2020-07-19Rollup merge of #74536 - Nicholas-Baron:master, r=joshtriplettManish Goregaokar-4/+4
fix documentation surrounding the `in` and `for` keywords Addresses #74529 The `in` keyword incorrectly referenced the `Iterator` trait. This reference was changed to `IntoIterator` without changing the underlying link. Additionally, the `IntoIterator` trait was referenced towards the end of the documentation for `for`. An additional reference was added earlier and broadened the existing documentation from any iterator to anything that can be turned into an iterator.
2020-07-19Rollup merge of #73618 - poliorcetics:false-keyword, r=jyn514Manish Goregaokar-3/+4
Documentation for the false keyword Partial fix of #34601. Short documentation for the false keyword mainly pointing to the `true` keyword.
2020-07-19Update src/libstd/keyword_docs.rs Nicholas Baron-1/+1
Clear up wording regarding the iterator and usage of `break`. Co-authored-by: Josh Triplett <josh@joshtriplett.org>
2020-07-19Linked the earlier mention of IntoIterator in the keyword 'for' docsNicholas-Baron-1/+1
2020-07-19Mentioned IntoIterator in keyword 'in' docsNicholas-Baron-2/+2
2020-07-19Mentioned IntoIterator earlier in keyword 'for' docsNicholas-Baron-2/+2
2020-07-19Apply suggestions from reviewPoliorcetics-1/+1
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-07-19Remove useless link to bool primitiveAlexis Bourget-1/+0
2020-07-18Rollup merge of #73762 - poliorcetics:trait-keyword, r=KodrAusManish Goregaokar-3/+180
Document the trait keyword Partial fix of #34601. This document the trait keyword. To avoid doing too much and forcing more updates as functionalities evolve, I put two links to the reference, especially for trait objects. This mainly documents the "big" parts, not so much the small details that might trip someone experimenting. @rustbot modify labels: T-doc,C-enhancement
2020-07-17Fix small nits, clarfying some confusing vocabulary and using more ↵Alexis Bourget-4/+12
consistent wording
2020-07-13Rollup merge of #73867 - poliorcetics:union-keyword, r=joshtriplettManish Goregaokar-2/+66
Document the union keyword Partial fix of #34601. This documents the `union` keyword by presenting three cases: simply using a union, matching on a union and referencing the fields of a union. @rustbot modify labels: T-doc,C-enhancement
2020-07-03Document the where keywordAlexis Bourget-2/+135
2020-07-01Rollup merge of #73805 - poliorcetics:type-keyword, r=kennytmManish Goregaokar-2/+37
Document the type keyword Partial fix of #34601. Two small examples, one clarifying that `type` only defines an alias, not a completely new type, the other explaining the use in traits. @rustbot modify labels: T-doc,C-enhancement
2020-07-01Rollup merge of #73716 - poliorcetics:static-keyword, r=LukasKalbertodtManish Goregaokar-3/+76
Document the static keyword Partial fix of #34601. This documents the `static` keyword. It's basically a simplified version of the reference with more examples. @rustbot modify labels: T-doc,C-enhancement
2020-06-30Clarify some parts by applying the suggestions from reviewPoliorcetics-6/+7
Co-authored-by: Josh Triplett <josh@joshtriplett.org>
2020-06-29Document the union keywordAlexis Bourget-2/+65
2020-06-28Fix small nitsAlexis Bourget-4/+3
2020-06-28Apply suggestions, reformulating some paragraphs and improving some examplesAlexis Bourget-38/+36
2020-06-28Apply suggestions from code reviewAlexis Bourget-2/+13
2020-06-27Document the type keywordAlexis Bourget-2/+26
2020-06-26Rollup merge of #73718 - poliorcetics:super-keyword, r=shepmasterManish Goregaokar-2/+18
Document the super keyword Partial fix of #34601. Quite short, just a small example and a link to the reference. @rustbot modify labels: T-doc,C-enhancement
2020-06-26Rollup merge of #73694 - poliorcetics:self-upper-keyword, r=Mark-SimulacrumManish Goregaokar-2/+57
Document the Self keyword Partial fix of #34601. Document the `Self` keyword. This contains simple examples of the places where `Self` can be used.
2020-06-26Document the trait keywordAlexis Bourget-3/+172
2020-06-25Rollup merge of #73648 - poliorcetics:return-keyword, r=joshtriplettManish Goregaokar-2/+48
Document the return keyword Partial fix of #34601. This documents the `return` keyword with two short example to explain it is not needed for the last expression in a function and a long example to show its use when interrupting a function execution early. I did not put a link to the reference since the only link I found was https://doc.rust-lang.org/stable/reference/expressions/return-expr.html#return-expressions. @rustbot modify labels: T-doc,C-enhancement
2020-06-25Rollup merge of #73621 - poliorcetics:mut-keyword, r=steveklabnikManish Goregaokar-3/+53
Document the mut keyword Partial fix for #34601. Documentation for the `mut` keyword. I think it's okay for it to be quite short, this is not the book not the reference, but if you find something is missing, do not hesitate to tell me.
2020-06-25Rollup merge of #73619 - poliorcetics:mod-keyword, r=steveklabnikManish Goregaokar-2/+20
Document the mod keyword Partial fix for #34601 . Documentation for the `mod` keyword.
2020-06-25Document the static keywordAlexis Bourget-2/+78
2020-06-25Document the super keywordAlexis Bourget-2/+18
2020-06-25Add a compile fail example, binding -> variable, apply suggestionsAlexis Bourget-13/+22
2020-06-24Document the Self keywordAlexis Bourget-2/+57
2020-06-24Short documentation for the false keywordAlexis Bourget-2/+4
2020-06-24Document the self keywordAlexis Bourget-2/+86
2020-06-24Document the return keywordAlexis Bourget-2/+48
Apply suggestions from code review Co-authored-by: Josh Triplett <josh@joshtriplett.org>
2020-06-23Document the ref keywordAlexis Bourget-2/+42
2020-06-22Document the mut keywordAlexis Bourget-2/+43
2020-06-22Document the mod keywordAlexis Bourget-2/+20
2020-05-30Remove the fn main() in code examplePoliorcetics-3/+1
2020-05-30Apply suggestions from code review Poliorcetics-2/+2
Fix suggestions from review. Co-authored-by: Bastian Kauschke <bastian_kauschke@hotmail.de>
2020-05-29Added the documentation for the 'use' keywordAlexis Bourget-2/+56
2020-04-24Fix typos in docs for keyword "in"Jubilee Young-2/+2
2020-03-18Rollup merge of #67749 - gilescope:keyword-in, r=Dylan-DPCMazdak Farrokhzad-5/+56
keyword docs for else and inkeyword docs for else and in. First cut of else and in keyword docs. Comments and suggestions more than welcome.
2020-03-13Add documentation for pub keywordsjud-2/+8
2020-02-28docs: add mention of async blocks in move keyword docsPulkit Goyal-0/+9
Fixes #69298