From 4e196a23483799ce114169b8b07cb3e195c107d3 Mon Sep 17 00:00:00 2001
From: Xu Cheng
Date: Sat, 7 Nov 2015 16:00:45 +0800
Subject: tap: add more document

---
 Library/Homebrew/tap.rb | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'Library')

diff --git a/Library/Homebrew/tap.rb b/Library/Homebrew/tap.rb
index f97383634..436ff89cc 100644
--- a/Library/Homebrew/tap.rb
+++ b/Library/Homebrew/tap.rb
@@ -149,15 +149,19 @@ class Tap
     @command_files ||= Pathname.glob("#{path}/cmd/brew-*").select(&:executable?)
   end
 
+  # path to the pin record for this {Tap}.
+  # @private
   def pinned_symlink_path
     HOMEBREW_LIBRARY/"PinnedTaps/#{@name}"
   end
 
+  # True if this {Tap} has been pinned.
   def pinned?
     return @pinned if instance_variable_defined?(:@pinned)
     @pinned = pinned_symlink_path.directory?
   end
 
+  # pin this {Tap}.
   def pin
     raise TapUnavailableError, name unless installed?
     raise TapPinStatusError.new(name, true) if pinned?
@@ -165,6 +169,7 @@ class Tap
     @pinned = true
   end
 
+  # unpin this {Tap}.
   def unpin
     raise TapUnavailableError, name unless installed?
     raise TapPinStatusError.new(name, false) unless pinned?
-- 
cgit v1.2.3