aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/pluginwriter
diff options
context:
space:
mode:
authorChristopher Allan Webber <cwebber@dustycloud.org>2013-05-29 18:10:09 -0500
committerChristopher Allan Webber <cwebber@dustycloud.org>2013-05-29 18:10:09 -0500
commitea49f37821410e4b46179853965cd9ac4f2b9688 (patch)
tree93a585f74a5f92b88609e6e256a5fea910c04f8d /docs/source/pluginwriter
parent9d881aeeb4df2e9f02c4c1fea7d6435273081fdb (diff)
downloadmediagoblin-ea49f37821410e4b46179853965cd9ac4f2b9688.tar.lz
mediagoblin-ea49f37821410e4b46179853965cd9ac4f2b9688.tar.xz
mediagoblin-ea49f37821410e4b46179853965cd9ac4f2b9688.zip
Explained more clearly why it's okay for interface classes to be keys.
This commit sponsored by Nick Glynn. Thank you!
Diffstat (limited to 'docs/source/pluginwriter')
-rw-r--r--docs/source/pluginwriter/api.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/source/pluginwriter/api.rst b/docs/source/pluginwriter/api.rst
index 3bb5f445..66def173 100644
--- a/docs/source/pluginwriter/api.rst
+++ b/docs/source/pluginwriter/api.rst
@@ -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::