Skip to content

Commit 644a4ff

Browse files
authored
Merge pull request rust-lang#35 from mrhota/undoc_appendix
Add appendix for list of undocumented features
2 parents fbd54f7 + d1a2d85 commit 644a4ff

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

src/SUMMARY.md

+2
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,5 @@
5656
- [Behavior not considered unsafe](behavior-not-considered-unsafe.md)
5757

5858
[Appendix: Influences](influences.md)
59+
60+
[Appendix: As-yet-undocumented Features](undocumented.md)

src/undocumented.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# As-yet-undocumented Features
2+
3+
Several accepted, stabilized, and implemented RFCs lack documentation in this
4+
reference, The Book, _Rust by Example_, or some combination of those three.
5+
Until we have written reference documentation for these features, we provide
6+
links to other sources of information about them. Therefore, expect this list
7+
to shrink!
8+
9+
- [`libstd` facade]
10+
- [Trait reform] – some partial documentation exists (the use of `Self`), but
11+
not for everything: e.g. coherence and orphan rules.
12+
- [Attributes on `match` arms] – the underlying idea is documented in the
13+
[Attributes] section, but the applicability to internal items is never
14+
specified.
15+
- [Flexible target specification] - Some---but not all---flags are documented
16+
in [Conditional compilation]
17+
- [Unambiguous function call syntax]
18+
- [Require parentheses for chained comparisons]
19+
- [Integer overflow not `unsafe`] - documented with a reference to the RFC, but
20+
requires further details
21+
- [`dllimport`] - one element mentioned but not explained at [FFI attributes]
22+
- [define `crt_link`]
23+
- [define `unaligned_access`]
24+
25+
[`libstd` facade]: https://github.com/rust-lang/rfcs/pull/40
26+
[Trait reform]: https://github.com/rust-lang/rfcs/pull/48
27+
[Attributes on `match` arms]: https://github.com/rust-lang/rfcs/pull/49
28+
[Flexible target specification]: https://github.com/rust-lang/rfcs/pull/131
29+
[Conditional compilation]: attributes.html#conditonal-compilation
30+
[Unambiguous function call syntax]: https://github.com/rust-lang/rfcs/pull/132
31+
[Require parentheses for chained comparisons]: https://github.com/rust-lang/rfcs/pull/558
32+
[Integer overflow not `unsafe`]: https://github.com/rust-lang/rfcs/pull/560
33+
[`dllimport`]: https://github.com/rust-lang/rfcs/pull/1717
34+
[FFI attributes]: attributes.html#ffi-attributes
35+
[define `crt_link`]: https://github.com/rust-lang/rfcs/pull/1721
36+
[define `unaligned_access`]: https://github.com/rust-lang/rfcs/pull/1725

0 commit comments

Comments
 (0)