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

Merge pull request #8972 from atom/tj-fix-deprecated-reference-in-docs

Browse Source 
Update reference to deprecated method Project::getRepo
This commit is contained in:
Thomas Johansen
2015-09-29 08:41:15 +02:00
parent 67af264c0d efda18ae73
commit 6166c81e4c
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/git-repository.coffee
View File

@@ -10,8 +10,8 @@ Task = require './task'
# Extended: Represents the underlying git operations performed by Atom.
#
# This class shouldn't be instantiated directly but instead by accessing the
# `atom.project` global and calling `getRepo()`. Note that this will only be
# available when the project is backed by a Git repository.
# `atom.project` global and calling `getRepositories()`. Note that this will
# only be available when the project is backed by a Git repository.
#
# This class handles submodules automatically by taking a `path` argument to many
# of the methods. This `path` argument will determine which underlying
@@ -20,7 +20,7 @@ Task = require './task'
# For a repository with submodules this would have the following outcome:
#
# ```coffee
# repo = atom.project.getRepo()
# repo = atom.project.getRepositories()[0]
# repo.getShortHead() # 'master'
# repo.getShortHead('vendor/path/to/a/submodule') # 'dead1234'
# ```
@@ -30,7 +30,7 @@ Task = require './task'
# ### Logging the URL of the origin remote
#
# ```coffee
# git = atom.project.getRepo()
# git = atom.project.getRepositories()[0]
# console.log git.getOriginURL()
# ```
#