diff --git a/doc/source/developing.rst b/doc/source/developing.rst index 4bf70d34..c6ec53a2 100644 --- a/doc/source/developing.rst +++ b/doc/source/developing.rst @@ -322,7 +322,7 @@ How to __str__ vs __repr__ """""""""""""""""""""""""" All objects must implement ``__str__`` (called by ``str()``), and ``__repr__`` (called by ``repr()``). -See `this issue `_ for a more detailed discussion. +See `this issue `_ for a more detailed discussion. In general ``__str__`` should return a one line string with enough information to uniquely identify the object. For numbered objects this should include their number, and a few high level details. For ``__repr__`` this should include debugging information.