From b329e970d9c2ab27b9f323e144588557ae6f55ba Mon Sep 17 00:00:00 2001 From: Scott Sanderson Date: Wed, 5 Sep 2018 00:14:36 -0400 Subject: [PATCH] DOC: Don't include "pass" in interface defs. --- docs/why.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/why.rst b/docs/why.rst index 0858d98..31a8cf2 100644 --- a/docs/why.rst +++ b/docs/why.rst @@ -18,10 +18,17 @@ definition for a simple `Key-Value Store`_ might look like this: class KeyValueStore(interface.Interface): def get(self, key): - pass + """Get the value for ``key``. + """ def set(self, key, value): - pass + """Set the value for ``key`` to ``value``. + """ + + def delete(self, key): + """Delete the value for ``key``. + """ + Why Are Interfaces Useful? ~~~~~~~~~~~~~~~~~~~~~~~~~~