From 2351c64a6064c04ce125fb8935226771f352736b Mon Sep 17 00:00:00 2001 From: Johannes Haux Date: Thu, 8 Aug 2019 14:31:27 +0200 Subject: [PATCH] Add code-block comment Because @ArWeHei does not have time for this! --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0160820..4df021f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,11 @@ The following is a set of guidelines for contributing to edflow. These are mostly guidelines, not rules. Use your best judgment on when to apply them and always be nice to each other :heart:. +> ### code-block +> In your docstring write **``.. code-block:: ``**, when showing examples. +> +> This comment is right here, because everyone seems to do it wrong. + #### Table Of Contents [Code of Conduct](#code-of-conduct)