# HG changeset patch
# User Artem Tikhomirov <tikhomirov.artem@gmail.com>
# Date 1350414447 -7200
# Node ID 4a670f76e7d1dfccc479e218e3dcd26d35035f9d
# Parent  b3c16d1aede0227247f9c64122d74f9e896f0068
Javadoc for HgRepository#getLocation()

diff -r b3c16d1aede0 -r 4a670f76e7d1 src/org/tmatesoft/hg/repo/HgRepository.java
--- a/src/org/tmatesoft/hg/repo/HgRepository.java	Thu Aug 16 17:08:34 2012 +0200
+++ b/src/org/tmatesoft/hg/repo/HgRepository.java	Tue Oct 16 21:07:27 2012 +0200
@@ -164,6 +164,17 @@
 		return getClass().getSimpleName() + "[" + getLocation() + (isInvalid() ? "(BAD)" : "") + "]";
 	}                         
 	
+	/**
+	 * Path to repository which has been used to initialize this instance. The value is always present, even 
+	 * if no repository has been found at that location ({@link #isInvalid()} is <code>true</code>) and serves 
+	 * as an extra description of the failure.
+	 * 
+	 * <p> It's important to understand this is purely descriptive attribute, it's kept as close as possible to 
+	 * original value users supply to {@link HgLookup}. To get actual repository location, use methods that 
+	 * provide {@link File}, e.g. {@link #getWorkingDir()}
+	 * 
+	 * @return repository location information, never <code>null</code>
+	 */
 	public String getLocation() {
 		return repoLocation;
 	}