From: Kevin McElwee <kevinrmcelwee@gmail.com>
Date: Tue, 15 Sep 2020 20:03:59 +0000 (-0400)
Subject: Document API.get_oembed method
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=a4c2a8a6aa462386322a7b590675e1fa9ee2dca8;p=tweepy.git

Document API.get_oembed method
---

diff --git a/docs/api.rst b/docs/api.rst
index 8aa4a03..9e2dbd8 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -282,6 +282,29 @@ Status methods
    :rtype: :class:`Status` object
 
 
+.. method:: API.get_oembed(id/url, [maxwidth], [hide_media], \
+      [omit_script], [align], [related], [lang])
+
+   Requests the Twitter oembed HTML for a given tweet.
+
+   :param id: |sid|
+   :param url: The URL of the Tweet to be embedded
+   :param maxwidth: The maximum width of a rendered Tweet in whole pixels.
+   :param hide_media: When set to `true`, links in a Tweet are not expanded to
+                      photo, video, or link previews.
+   :param omit_script: When set to `true`, the `<script>` responsible for
+                       loading `widgets.js` will not be returned. Your webpages
+                       should include their own reference to `widgets.js`
+   :param align: Specifies whether the embedded Tweet should be floated left,
+                 right, or center in the page relative to the parent element.
+   :param related: A comma-separated list of Twitter usernames related to your
+                   content.
+   :param lang: Request returned HTML and a rendered Tweet in the specified
+                Twitter language supported by embedded Tweets.
+
+   :rtype: `JSON` object
+
+
 User methods
 ------------