Document ConfigDir

[btrtrc.git] / client.go

diff --git a/client.go b/client.go
index 3e63cf9bb9d5732b3c64bb42a132a85cbe70d8f2..d2c2b4510c1e6617d0a55e99fbea274c79af028c 100644 (file)
--- a/client.go
+++ b/client.go
@@ -336,6 +336,8 @@ func (cl *Client) configDir() string {
        return cl.config.ConfigDir
 }
 
+// The directory where the Client expects to find and store configuration
+// data. Defaults to $HOME/.config/torrent.
 func (cl *Client) ConfigDir() string {
        return cl.configDir()
 }