Permalink
Browse files

Update IBackend's docstrings.

  • Loading branch information...
1 parent 1c6972e commit f1691884038f1bd673a71904110ac7cd2708d01e @allenap committed Jul 5, 2012
Showing with 4 additions and 2 deletions.
  1. +4 −2 tftp/backend.py
View
6 tftp/backend.py
@@ -32,7 +32,8 @@ def get_reader(file_name):
@raise BackendError: for any other errors, that were encountered while
attempting to construct a reader
- @return: an object, that provides L{IReader}
+ @return: an object, that provides L{IReader}, or a L{Deferred} that
+ will fire with an L{IReader}
"""
@@ -55,7 +56,8 @@ def get_writer(file_name):
@raise BackendError: for any other errors, that were encountered while
attempting to construct a writer
- @return: an object, that provides L{IWriter}
+ @return: an object, that provides L{IWriter}, or a L{Deferred} that
+ will fire with an L{IWriter}
"""

0 comments on commit f169188

Please sign in to comment.