From: Andrew Lewis <nerf@judo.za.org>
Date: Mon, 11 Oct 2021 13:36:52 +0000 (+0200)
Subject: [Minor] API docs: try explain real_ip / from_ip better
X-Git-Tag: 3.1~55^2~1
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=4e4d56c4fe36dfb5481966d321f821a56dd86407;p=rspamd.git

[Minor] API docs: try explain real_ip / from_ip better
---

diff --git a/src/lua/lua_task.c b/src/lua/lua_task.c
index 1eb67a430..42cdd22f0 100644
--- a/src/lua/lua_task.c
+++ b/src/lua/lua_task.c
@@ -446,9 +446,9 @@ LUA_FUNCTION_DEF (task, modify_header);
  * the following structure:
  *
  * - `from_hostname` - string that represents hostname provided by a peer
- * - `from_ip` - string representation of IP address as provided by a peer
+ * - `from_ip` - string representation of sending IP address
  * - `real_hostname` - hostname as resolved by MTA
- * - `real_ip` - string representation of IP as resolved by PTR request of MTA
+ * - `real_ip` - rspamd_ip object representing sending IP address
  * - `by_hostname` - MTA hostname
  * - `proto` - protocol, e.g. ESMTP or ESMTPS
  * - `timestamp` - received timestamp