Skip to content

Fix typos in README, docs and docstrings #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ yt = YouTubeDataAPI(api_key)
yt.search('alexandria ocasio-cortez')
```

The `yt` object calls functions that automate the collection of data fields that are both visable and not-visable to everyday users.
The `yt` object calls functions that automate the collection of data fields that are both visible and not-visible to everyday users.

Please refer to the [documentation](http://bit.ly/YouTubeDataAPI) for details.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/usage/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ perfect for converting into Pandas `DataFrames <https://pandas.pydata.org/pandas



Aside from the default parser, the ``parse`` argument allows users to create custom functions to parse and process API resonses. You can also get raw JSON from the API by using the :meth:`youtube_api.parsers.raw_json` parser, or setting parser to ``None``.
Aside from the default parser, the ``parse`` argument allows users to create custom functions to parse and process API responses. You can also get raw JSON from the API by using the :meth:`youtube_api.parsers.raw_json` parser, or setting parser to ``None``.

.. code:: python

Expand Down
2 changes: 1 addition & 1 deletion docs/source/youtube_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This is the client class to access the YouTube API.

youtube_api.parsers module
--------------------------
Every function from the :mod:`youtube_api.youtube_api` class has an argument for ``parser``. ``parser`` can be any function that takes a dictionary as input. Here are the default parser fucntions for each function. Use these as templates to build your own custom parsers, or use the :meth:`youtube_api.parsers.raw_json` or ``None`` as the ``parser`` argument for the raw API response.
Every function from the :mod:`youtube_api.youtube_api` class has an argument for ``parser``. ``parser`` can be any function that takes a dictionary as input. Here are the default parser functions for each function. Use these as templates to build your own custom parsers, or use the :meth:`youtube_api.parsers.raw_json` or ``None`` as the ``parser`` argument for the raw API response.

.. automodule:: youtube_api.parsers
:members:
Expand Down
2 changes: 1 addition & 1 deletion youtube_api/parsers.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def parse_video_url(item):

def parse_channel_metadata(item):
'''
Parses and processes raw output and returns channel_id, title, account_creatation_date, keywords, description, view_count, video_count, subscription_count, playlist_id_likes, playlist_id_uploads, topic_ids, country, collection_date.
Parses and processes raw output and returns channel_id, title, account_creation_date, keywords, description, view_count, video_count, subscription_count, playlist_id_likes, playlist_id_uploads, topic_ids, country, collection_date.

:params item: json document
:type item: dict
Expand Down
8 changes: 4 additions & 4 deletions youtube_api/youtube_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ def _http_request(self, http_endpoint, timeout_in_n_seconds=False):

def get_channel_id_from_user(self, username, **kwargs):
"""
Get a channel_id from a YouTube username. These are the unique identifiers for all YouTube "uers". IE. "Munchies" -> "UCaLfMkkHhSA_LaCta0BzyhQ".
Get a channel_id from a YouTube username. These are the unique identifiers for all YouTube "users". IE. "Munchies" -> "UCaLfMkkHhSA_LaCta0BzyhQ".

Read the docs: https://developers.google.com/youtube/v3/docs/channels/list

Expand Down Expand Up @@ -340,7 +340,7 @@ def get_videos_from_playlist_id(self, playlist_id, next_page_token=None,
Read the docs: https://developers.google.com/youtube/v3/docs/playlistItems

:param playlist_id: the playlist_id IE: "UUaLfMkkHhSA_LaCta0BzyhQ"
:type platlist_id: str
:type playlist_id: str
:param next_page_token: a token to continue from a preciously stopped query IE: "CDIQAA"
:type next_page_token: str
:param parser: the function to parse the json document
Expand Down Expand Up @@ -608,7 +608,7 @@ def search(self, q=None, channel_id=None,
:type published_after: datetime
:param published_before: Only show videos uploaded before datetime
:type published_before: datetime
:param location: Coodinates of video uploaded in location.
:param location: Coordinates of video uploaded in location.
:type location: tuple
:param location_radius: The radius from the ``location`` param to include in the search.
:type location_radius: str
Expand Down Expand Up @@ -741,6 +741,6 @@ def get_recommended_videos(self, video_id, max_results=5,


class YoutubeDataApi(YouTubeDataAPI):
"""Variant case of the main YouTubeDataAPI class. This class will de depricated by version 0.0.21"""
"""Variant case of the main YouTubeDataAPI class. This class will be deprecated by version 0.0.21"""
def __init__(self, key, **kwargs):
super().__init__(key, **kwargs)