German Larrain  committed becd457

graphics.ScreenshotRecorder: updated docstring of 'write'.

  • Participants
  • Parent commits b789d87
  • Branches dev

Comments (0)

Files changed (1)

File ars/graphics/

 	def write(self, index, time):
-		"""
-		Writes the current image displayed in the render window as a file
-		named 'self.base_filename' with	the 'index' number appended, and the
-		corresponding extension.
+		"""Write render-window's currently displayed image to a file.
+		The image format (thus the file extension too) to use must be defined
+		by the implementation.
+		Image's filename is determined by :meth:`calc_filename`.
+		:param index: image's index to use for filename calculation
+		:type index: int
+		:param time:
+		:type time:
 		raise NotImplementedError()