github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-01-24 06:18:03 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9132 from mrodalgaard/workspace-docs

Browse Source 
📝 Better workspace scan and replace docs
This commit is contained in:
Max Brunsfeld
2015-10-13 13:53:31 -07:00
parent 22eb6d6d01 5b37d3e1aa
commit 1316a52a81
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/workspace.coffee
View File

@@ -812,13 +812,14 @@ class Workspace extends Model
Section: Searching and Replacing
###
# Public: Performs a search across all the files in the workspace.
# Public: Performs a search across all files in the workspace.
#
# * `regex` {RegExp} to search with.
# * `options` (optional) {Object} (default: {})
# * `paths` An {Array} of glob patterns to search within
# * `onPathsSearched` (optional) {Function}
# * `iterator` {Function} callback on each file found
# * `options` (optional) {Object}
# * `paths` An {Array} of glob patterns to search within.
# * `onPathsSearched` (optional) {Function} to be periodically called
# with number of paths searched.
# * `iterator` {Function} callback on each file found.
#
# Returns a `Promise` with a `cancel()` method that will cancel all
# of the underlying searches that were started as part of this scan.
@@ -918,10 +919,10 @@ class Workspace extends Model
# Public: Performs a replace across all the specified files in the project.
#
# * `regex` A {RegExp} to search with.
# * `replacementText` Text to replace all matches of regex with
# * `filePaths` List of file path strings to run the replace on.
# * `replacementText` {String} to replace all matches of regex with.
# * `filePaths` An {Array} of file path strings to run the replace on.
# * `iterator` A {Function} callback on each file with replacements:
# * `options` {Object} with keys `filePath` and `replacements`
# * `options` {Object} with keys `filePath` and `replacements`.
#
# Returns a `Promise`.
replace: (regex, replacementText, filePaths, iterator) ->