Browse Source

Document ServerConn is not safe for concurrent use.

Mention textproto.Error so users can access the error code via type
assertion (issue #78).
Julien Laffaye 8 years ago
parent
commit
7b85eb4638
1 changed files with 3 additions and 0 deletions
  1. 3 0
      ftp.go

+ 3 - 0
ftp.go

@@ -1,4 +1,6 @@
 // Package ftp implements a FTP client as described in RFC 959.
+//
+// A textproto.Error is returned for errors at the protocol level.
 package ftp
 
 import (
@@ -23,6 +25,7 @@ const (
 )
 
 // ServerConn represents the connection to a remote FTP server.
+// It should be protected from concurrent accesses.
 type ServerConn struct {
 	// Do not use EPSV mode
 	DisableEPSV bool