📝 Mention that atom.project.getRepo() might be unavailable

2026-01-23 13:58:08 -05:00 · 2014-01-21 17:45:32 -08:00
parent e9c296968d
commit 1d9bca12e0
1 changed files with 2 additions and 1 deletions
--- a/src/git.coffee
+++ b/src/git.coffee
@@ -7,7 +7,8 @@ GitUtils = require 'git-utils'
 # Public: 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()`.
+# `atom.project` global and calling `getRepo()`. Note that this will only be
+# available when the project is backed by a Git repository.
 #
 # ## Example
 #