Browse Source

Documented the parameter to SinkConfig.from_text

Clara Hobbs 7 years ago
parent
commit
eb46ce6cde
1 changed files with 3 additions and 1 deletions
  1. 3
    1
      pdbuddy/__init__.py

+ 3
- 1
pdbuddy/__init__.py View File

268
     @classmethod
268
     @classmethod
269
     def from_text(cls, text):
269
     def from_text(cls, text):
270
         """Creates a SinkConfig from text returned by Sink.send_command
270
         """Creates a SinkConfig from text returned by Sink.send_command
271
-        
271
+
272
+        :param text: the text to load
273
+        :type text: a list of bytes objects
272
         :returns: a new `SinkConfig` object.
274
         :returns: a new `SinkConfig` object.
273
 
275
 
274
         :raises: IndexError
276
         :raises: IndexError

Loading…
Cancel
Save