Fix doc strings

This commit is contained in:
Ben Ogle
2014-09-04 14:53:33 -07:00
parent 326f5fc646
commit 2c9241506b
2 changed files with 9 additions and 9 deletions

View File

@@ -70,9 +70,9 @@ class EditorView extends View
# The constructor for setting up an `EditorView` instance.
#
# * `editorOrParams` Either an {Editor}, or an object with one property, `mini`.
# If `mini` is `true`, a "miniature" `Editor` is constructed.
# Typically, this is ideal for scenarios where you need an Atom editor,
# but without all the chrome, like scrollbars, gutter, _e.t.c._.
# If `mini` is `true`, a "miniature" `Editor` is constructed.
# Typically, this is ideal for scenarios where you need an Atom editor,
# but without all the chrome, like scrollbars, gutter, _e.t.c._.
#
constructor: (editorOrParams, props) ->
super

View File

@@ -20,9 +20,9 @@ Task = require './task'
# For a repository with submodules this would have the following outcome:
#
# ```coffee
# repo = atom.project.getRepo()
# repo.getShortHead() # 'master'
# repo.getShortHead('vendor/path/to/a/submodule') # 'dead1234'
# repo = atom.project.getRepo()
# repo.getShortHead() # 'master'
# repo.getShortHead('vendor/path/to/a/submodule') # 'dead1234'
# ```
#
# ## Examples
@@ -30,14 +30,14 @@ Task = require './task'
# ### Logging the URL of the origin remote
#
# ```coffee
# git = atom.project.getRepo()
# console.log git.getOriginUrl()
# git = atom.project.getRepo()
# console.log git.getOriginUrl()
# ```
#
# ### Requiring in packages
#
# ```coffee
# {Git} = require 'atom'
# {Git} = require 'atom'
# ```
module.exports =
class Git