📝 Document the async onWillSave behavior

maxbrunsfeld · maxbrunsfeld · commit 2fedad357594 · 2017-09-12T15:13:14.000-07:00
diff --git a/src/text-buffer.coffee b/src/text-buffer.coffee
@@ -482,7 +482,8 @@ class TextBuffer
 
   # Public: Invoke the given callback before the buffer is saved to disk.
   #
-  # * `callback` {Function} to be called before the buffer is saved.
+  # * `callback` {Function} to be called before the buffer is saved. If this function returns
+  #   a {Promise}, then the buffer will not be saved until the promise resolves.
   #
   # Returns a {Disposable} on which `.dispose()` can be called to unsubscribe.
   onWillSave: (callback) ->

Original file line number	Diff line number	Diff line change
`@@ -482,7 +482,8 @@ class TextBuffer`
`482`	`482`
`483`	`483`	`# Public: Invoke the given callback before the buffer is saved to disk.`
`484`	`484`	`#`
`485`		- # * `callback` {Function} to be called before the buffer is saved.
	`485`	+ # * `callback` {Function} to be called before the buffer is saved. If this function returns
	`486`	`+ # a {Promise}, then the buffer will not be saved until the promise resolves.`
`486`	`487`	`#`
`487`	`488`	# Returns a {Disposable} on which `.dispose()` can be called to unsubscribe.
`488`	`489`	`onWillSave: (callback) ->`