Explorar o código

Refs #31029 -- Added note about :rfc: role in writing documentation docs.

Baptiste Mispelon %!s(int64=5) %!d(string=hai) anos
pai
achega
42df1b178b
Modificáronse 1 ficheiros con 4 adicións e 0 borrados
  1. 4 0
      docs/internals/contributing/writing-documentation.txt

+ 4 - 0
docs/internals/contributing/writing-documentation.txt

@@ -235,6 +235,10 @@ documentation:
     Five
     ^^^^
 
+* Use :rst:role:`:rfc:<rfc>` to reference RFC and and try to link to the
+  relevant section if possible. For example, use ``:rfc:`2324#section-2.3.2```
+  or ``:rfc:`Custom link text <2324#section-2.3.2>```.
+
 Django-specific markup
 ======================