Update documentation for dm_event_fields parameter

This documentation was previously inaccurate when the Twitter API v2 Direct Messages endpoints were launched but has now recently been updated.

diff --git a/tweepy/asynchronous/client.py b/tweepy/asynchronous/client.py
index e0bdf3c636630334083ad051f41515216d3f5293..19749e9226225278a4f1ef4f82ea67522dbbc6cc 100644 (file)
--- a/tweepy/asynchronous/client.py
+++ b/tweepy/asynchronous/client.py
@@ -2602,8 +2602,9 @@ class AsyncClient(AsyncBaseClient):
             The ``participant_id`` of the user that the authenicating user is
             having a 1-1 conversation with.
         dm_event_fields : list[str] | str | None
-            Extra fields to include in the event payload. ``id``, ``text``, and
-            ``event_type`` are returned by default.
+            Extra fields to include in the event payload. ``id`` and
+            ``event_type`` are returned by default. The ``text`` value isn't
+            included for ``ParticipantsJoin`` and ``ParticipantsLeave`` events.
         event_types : str
             The type of Direct Message event to returm. If not included, all
             types are returned.

diff --git a/tweepy/client.py b/tweepy/client.py
index 2afda8ecbb90075e29930cb36c9b1d8643a17c23..47efd332f24d778583fcb7a09eb3cb04f087008c 100644 (file)
--- a/tweepy/client.py
+++ b/tweepy/client.py
@@ -2812,8 +2812,9 @@ class Client(BaseClient):
             The ``participant_id`` of the user that the authenicating user is
             having a 1-1 conversation with.
         dm_event_fields : list[str] | str | None
-            Extra fields to include in the event payload. ``id``, ``text``, and
-            ``event_type`` are returned by default.
+            Extra fields to include in the event payload. ``id`` and
+            ``event_type`` are returned by default. The ``text`` value isn't
+            included for ``ParticipantsJoin`` and ``ParticipantsLeave`` events.
         event_types : str
             The type of Direct Message event to returm. If not included, all
             types are returned.