github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-02-15 17:15:24 -05:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: workspace.open( ) with no URI

Browse Source 
I just learned that [calling open on workspace](https://discuss.atom.io/t/how-can-we-help-you-write-packages/4268/67) without specifying an uri is the way to go for getting a new tab with a new document. 

I can't find anything about this in either the docs or the [api documentation.](https://atom.io/docs/api/v0.187.0/Workspace#instance-open)

Should `uri` be marked optional, like the `options` params? And should it be added a line stating that no uri opens a blank editor?

(and there's an extra `a` in the title..)
This commit is contained in:
vegar
2015-03-17 20:09:37 +01:00
parent 916f3c0996
commit fec8ea4272
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/workspace.coffee
View File

@@ -371,9 +371,11 @@ class Workspace extends Model
Section: Opening
###
# Essential: Open a given a URI in Atom asynchronously.
#
# * `uri` A {String} containing a URI.
# Essential: Open a given URI in Atom asynchronously.
# If no URI is given, or URI does not resolve to an existing file,
# a new empty text edtior is created.
#
# * `uri` (optional) A {String} containing a URI.
# * `options` (optional) {Object}
# * `initialLine` A {Number} indicating which row to move the cursor to
# initially. Defaults to `0`.