This repository was archived by the owner on Dec 15, 2022. It is now read-only.
Doc change for setFile (existsSync is necessary) #293
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
existsSync method is necessary for the object passed into setFile. Should be reflected in comment atom/issues/258
Arcanemagus
reviewed
Mar 15, 2018
src/text-buffer.coffee
Outdated
| @@ -576,6 +576,7 @@ class TextBuffer | |||
| # * `getPath` A {Function} that returns the {String} path to the file. | |||
| # * `createReadStream` A {Function} that returns a `Readable` stream | |||
| # that can be used to load the file's content. | |||
| # * `existsSync` A {function} that returns the {Boolean}, true if the file exists, false otherwise | |||
There was a problem hiding this comment.
Can this be moved below createWriteStream so it doesn't split the two create___Stream properties up?
There was a problem hiding this comment.
Great catch, thanks! I've reordered them, such that they write streams are together.
Arcanemagus
approved these changes
Mar 15, 2018
Arcanemagus
suggested changes
Mar 15, 2018
src/text-buffer.coffee
Outdated
| @@ -578,6 +578,7 @@ class TextBuffer | |||
| # that can be used to load the file's content. | |||
| # * `createWriteStream` A {Function} that returns a `Writable` stream | |||
| # that can be used to save content to the file. | |||
| # * `existsSync` A {function} that returns the {Boolean}, true if the file exists, false otherwise | |||
There was a problem hiding this comment.
Whoops, caught these on a last check:
{function}should be{Function}- Add a
.on the end returns the {Boolean}->returns a {Boolean}
Arcanemagus
approved these changes
Mar 15, 2018
|
Great catches again, thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
existsSync method is necessary for the object passed into setFile. Should be reflected in comment /issues/258