From 5bdd6223a24b2bcd0ee32251d6f3ce20e934a1dd Mon Sep 17 00:00:00 2001 From: Joseph Victor Zammit Date: Mon, 23 Jan 2023 21:29:05 +0100 Subject: [4.2.x] Refs #34140 -- Corrected rst code-block and various formatting issues in docs. Backport of ba755ca13123d2691a0926ddb64e5d0a2906a880 from main --- docs/internals/contributing/writing-code/coding-style.txt | 9 +++++---- docs/internals/contributing/writing-code/submitting-patches.txt | 1 + 2 files changed, 6 insertions(+), 4 deletions(-) (limited to 'docs/internals/contributing/writing-code') diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt index 76198b6860..ca94eaa1fc 100644 --- a/docs/internals/contributing/writing-code/coding-style.txt +++ b/docs/internals/contributing/writing-code/coding-style.txt @@ -199,9 +199,10 @@ Imports class Example: - # ... + ... -* Use convenience imports whenever available. For example, do this:: +* Use convenience imports whenever available. For example, do this + :: from django.views import View @@ -236,12 +237,12 @@ View style Do this:: def my_view(request, foo): - # ... + ... Don't do this:: def my_view(req, foo): - # ... + ... Model style =========== diff --git a/docs/internals/contributing/writing-code/submitting-patches.txt b/docs/internals/contributing/writing-code/submitting-patches.txt index 4f7811ccfa..0ab3e27def 100644 --- a/docs/internals/contributing/writing-code/submitting-patches.txt +++ b/docs/internals/contributing/writing-code/submitting-patches.txt @@ -207,6 +207,7 @@ You can also add a test for the deprecation warning:: msg = 'Expected deprecation message' with self.assertWarnsMessage(RemovedInDjangoXXWarning, msg): # invoke deprecated behavior + ... Finally, there are a couple of updates to Django's documentation to make: -- cgit v1.3