nficano commited on
Commit
53fbdd3
·
1 Parent(s): 65a5078

pydoc types

Browse files
Files changed (1) hide show
  1. pytube/streams.py +6 -3
pytube/streams.py CHANGED
@@ -147,9 +147,10 @@ class Stream(object):
147
  def download(self, output_path=None):
148
  """Write the media stream to disk.
149
 
150
- :param str output_path:
151
  (optional) Output path for writing media file. If one is not
152
  specified, defaults to the current working directory.
 
153
 
154
  """
155
  # TODO(nficano): allow a filename to specified.
@@ -179,7 +180,7 @@ class Stream(object):
179
 
180
  :param str chunk:
181
  Segment of media file binary data, not yet written to disk.
182
- :param :class:`~_io.BufferedWriter` file_handle:
183
  The file handle where the media is being written to.
184
  :param int bytes_remaining:
185
  The delta between the total file size in bytes and amount already
@@ -203,8 +204,10 @@ class Stream(object):
203
 
204
  def on_complete(self, file_handle):
205
  """On download complete handler function.
206
- :param :class:`~_io.BufferedWriter` file_handle:
207
  The file handle where the media is being written to.
 
 
208
 
209
  """
210
  logger.debug('download finished')
 
147
  def download(self, output_path=None):
148
  """Write the media stream to disk.
149
 
150
+ :param output_path:
151
  (optional) Output path for writing media file. If one is not
152
  specified, defaults to the current working directory.
153
+ :type output_path: str or None
154
 
155
  """
156
  # TODO(nficano): allow a filename to specified.
 
180
 
181
  :param str chunk:
182
  Segment of media file binary data, not yet written to disk.
183
+ :param BufferedWriter file_handle:
184
  The file handle where the media is being written to.
185
  :param int bytes_remaining:
186
  The delta between the total file size in bytes and amount already
 
204
 
205
  def on_complete(self, file_handle):
206
  """On download complete handler function.
207
+ :param file_handle:
208
  The file handle where the media is being written to.
209
+ :type file_handle:
210
+ BufferedWriter
211
 
212
  """
213
  logger.debug('download finished')