From e666ff20139603bb0071de1119e2e64fb4fdad9c Mon Sep 17 00:00:00 2001 From: vvyomjjain Date: Wed, 3 Oct 2018 12:13:36 +0530 Subject: [PATCH] Add neither-nor statement and capitalization --- README.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index b4d85be..e4fd049 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,7 @@ newsapi Python wrapper around ``A JSON API for live news and blog headlines`` (a.k.a. ``News Api``): https://newsapi.org/ -**NOTE:** This library and its author are not endorsed by or affiliated with `NewsApi.org `_. +**NOTE:** This library and its author are neither endorsed by nor affiliated with `NewsApi.org `_. Installation @@ -133,21 +133,21 @@ All methods are accessible via: ====================================== ========================================================================================================== =============================================================================================================== ======================== Method Parameters Description Returns ====================================== ========================================================================================================== =============================================================================================================== ======================== -``get()`` category (optional), language (optional), country (optional), attributes_format (optional Default:True). Generic request to NewsApi to get sources as needed with optional params. (default : empty returns all sources ``AttrDict`` +``get()`` category (optional), language (optional), country (optional), attributes_format (optional, Default:True). Generic request to NewsApi to get sources as needed with optional params. (default : empty returns all sources ``AttrDict`` ``all()`` No parameters needed. wrapper around get() to get all sources unfiltered. ``AttrDict`` ``get_by_category()`` category (required). The category you would like to get sources for. ``AttrDict`` ``get_by_language()`` language (required). The 2-letter ISO-639-1 code of the language you would like to get sources for. ``AttrDict`` ``get_by_country()`` country (required). The 2-letter ISO 3166-1 code of the country you would like to get sources for. ``AttrDict`` ``information()`` No parameters needed. Sets up everything by sending an unfiltered request and then sorting it. ``Self`` -``all_sorted_information()`` No parameters needed. gives back all the sources. ``Array`` +``all_sorted_information()`` No parameters needed. Gives back all the sources. ``Array`` ``all_categories`` detailed (optional, Default: False, gives all the information of sources group by categories). Gets all the categories available by newsapi and grouped with info if detailed set to true. ``dict_keys``/``Dict`` ``all_languages`` detailed (optional, Default: False, gives all the information of sources group by languages). Gets all the languages available by newsapi and grouped with info if detailed set to true. ``dict_keys``/``Dict`` ``all_countries`` detailed (optional, Default: False, gives all the information of sources group by countries). Gets all the countries available by newsapi and grouped with info if detailed set to true. ``dict_keys``/``Dict`` -``all_base_information()`` No parameters needed. gives back all the name, id pairs of the available sources offered by newsapi. ``Dict`` -``all_ids()`` detailed (optional, Default: False, gives name, id pair of all the sources). gives back all the ids of the available sources offered by newsapi. ``dict_values``/``Dict`` -``all_names()`` detailed (optional, Default: False, gives name, url pair of all the sources). gives back all the names of the available sources offered by newsapi. ``dict_keys``/``Dict`` -``all_urls()`` detailed (optional, Default: False, gives name, url pair of all the sources). gives back all the urls of the available sources offered by newsapi. ``dict_values``/``Dict`` -``search()`` name (required, the name of the source you wanna search for). gives back all the matches from the given name of the source to avaiable ones by newsapi with all the info. ``Array`` +``all_base_information()`` No parameters needed. Gives back all the name, id pairs of the available sources offered by newsapi. ``Dict`` +``all_ids()`` detailed (optional, Default: False, gives name, id pair of all the sources). Gives back all the ids of the available sources offered by newsapi. ``dict_values``/``Dict`` +``all_names()`` detailed (optional, Default: False, gives name, url pair of all the sources). Gives back all the names of the available sources offered by newsapi. ``dict_keys``/``Dict`` +``all_urls()`` detailed (optional, Default: False, gives name, url pair of all the sources). Gives back all the URLs of the available sources offered by newsapi. ``dict_values``/``Dict`` +``search()`` name (required, the name of the source you wanna search for). Gives back all the matches from the given name of the source to avaiable ones by newsapi with all the info. ``Array`` ====================================== ========================================================================================================== =============================================================================================================== ======================== **NOTE:** By default all ``newsapi`` responses are formatted as ``JSON``, ``AttrDict`` is just a wrapper around Dictionary which enables to do content.status as well as content['status'], but can't do it in nested dicts.