Explained more clearly why it's okay for interface classes to be keys.
authorChristopher Allan Webber <cwebber@dustycloud.org>
Wed, 29 May 2013 23:10:09 +0000 (18:10 -0500)
committerChristopher Allan Webber <cwebber@dustycloud.org>
Wed, 29 May 2013 23:10:09 +0000 (18:10 -0500)
This commit sponsored by Nick Glynn.  Thank you!

docs/source/pluginwriter/api.rst

index 3bb5f445e98fa594224b3fd62f865008135ebf54..66def1730b163332a5f8fac3b4cc334fdab6d4dc 100644 (file)
@@ -273,7 +273,9 @@ Just write the interface like so::
 
 
 It's fine to use your interface as the key instead of a string if you
-like.
+like.  (Usually this is messy, but since interfaces are public and
+since you need to import them into your plugin anyway, interfaces
+might as well be keys.)
 
 Then a plugin providing your interface can be like::