update docs

labstack · Feb 2, 2020 · a6a92c0 · a6a92c0
1 parent 76c3f6e
commit a6a92c0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/context.go b/context.go
@@ -42,6 +42,7 @@ type (
 
 		// RealIP returns the client's network address based on `X-Forwarded-For`
 		// or `X-Real-IP` request header.
+		// The behavior can be configured using `Echo#IPExtractor`.
 		RealIP() string
 
 		// Path returns the registered path for the handler.

diff --git a/ip.go b/ip.go
@@ -6,7 +6,9 @@ import (
 	"strings"
 )
 
-// IPExtractor is a function to extract IP addr from http.Request
+// IPExtractor is a function to extract IP addr from http.Request.
+// Set appropriate one to Echo#IPExtractor.
+// See https://echo.labstack.com/guide/ip-address for more details.
 type IPExtractor func(*http.Request) string
 
 // ExtractIPDirect extracts IP address using actual IP address.