From 1e93210f1f622b692dd65e861f0793ac61552d28 Mon Sep 17 00:00:00 2001 From: Mikkel Munch Mortensen <3xm@detfalskested.dk> Date: Tue, 21 Mar 2017 15:12:41 +0100 Subject: [PATCH] Fixed #27963 -- Removed unneeded docstring example in contributing docs. --- docs/internals/contributing/writing-code/coding-style.txt | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt index abed891d63..e3ce27a99c 100644 --- a/docs/internals/contributing/writing-code/coding-style.txt +++ b/docs/internals/contributing/writing-code/coding-style.txt @@ -39,13 +39,7 @@ Python style * Use ``InitialCaps`` for class names (or for factory functions that return classes). -* In docstrings, follow :pep:`257`. For example:: - - def foo(): - """ - Calculate something and return the result. - """ - ... +* In docstrings, follow the style of existing docstrings and :pep:`257`. * In tests, use :meth:`~django.test.SimpleTestCase.assertRaisesMessage` instead of :meth:`~unittest.TestCase.assertRaises` so you can check the exception