Skip to content

Commit

Permalink
Add documentation for Place
Browse files Browse the repository at this point in the history
  • Loading branch information
Harmon758 committed Feb 27, 2022
1 parent c2dacc8 commit e3fa223
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/v2_models.rst
Expand Up @@ -18,9 +18,10 @@ Models

.. autoclass:: Media()

.. class:: tweepy.Place
:class:`Place`
==============

:reference: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/place
.. autoclass:: Place()

.. class:: tweepy.Poll

Expand Down
38 changes: 38 additions & 0 deletions tweepy/place.py
Expand Up @@ -6,6 +6,44 @@


class Place(HashableID, DataMapping):
"""The place tagged in a Tweet is not a primary object on any endpoint, but
can be found and expanded in the Tweet resource.
The object is available for expansion with ``?expansions=geo.place_id`` to
get the condensed object with only default fields. Use the expansion with
the field parameter: ``place.fields`` when requesting additional fields to
complete the object.
.. versionadded:: 4.0
Attributes
----------
data : dict
The JSON data representing the place.
full_name : str
A longer-form detailed place name.
id : str
The unique identifier of the expanded place, if this is a point of
interest tagged in the Tweet.
contained_within : list | None
Returns the identifiers of known places that contain the referenced
place.
country : str | None
The full-length name of the country this place belongs to.
country_code : str | None
The ISO Alpha-2 country code this place belongs to.
geo : dict | None
Contains place details in GeoJSON format.
name : str | None
The short name of this place.
place_type : str | None
Specified the particular type of information represented by this place
information, such as a city name, or a point of interest.
References
----------
https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/place
"""

__slots__ = (
"data", "full_name", "id", "contained_within", "country",
Expand Down

0 comments on commit e3fa223

Please sign in to comment.