dnrops
/
rfcs
mirror of https://github.com/rust-lang/rfcs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add note to RFC 505 that it has been amended 

RFC 1574 amended RFC 505. This change adds a note to the beginning of RFC 505, linking to RFC 1574 and the combined version of the conventions contained in Appendix A of RFC 1574.
This commit is contained in:
Lukas H 2018-01-10 21:16:19 +01:00 committed by GitHub
parent f337beaa0e
commit ced5085a1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
text/0505-api-comment-conventions.md
View File

@ -2,6 +2,13 @@
- RFC PR: [rust-lang/rfcs#505](https://github.com/rust-lang/rfcs/pull/505) - RFC PR: [rust-lang/rfcs#505](https://github.com/rust-lang/rfcs/pull/505)
- Rust Issue: N/A - Rust Issue: N/A
# Note
This RFC has been amended by [RFC 1574], which contains [a combined version of the conventions][combined].
[RFC 1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md
[combined]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
# Summary # Summary
This is a conventions RFC, providing guidance on providing API documentation This is a conventions RFC, providing guidance on providing API documentation