German Larrain avatar German Larrain committed becd457

graphics.ScreenshotRecorder: updated docstring of 'write'.

Comments (0)

Files changed (1)

ars/graphics/__init__.py

 
 	@abstractmethod
 	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()
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.