Merge pull request #520 from DLu/spell_check

Results from running codespell

Author: arunkannawadi

CHANGELOG.md

@@ -8,7 +8,7 @@
 ### Bugfixes
 - Fix pprint failures on Windows #413.
 - Thoroughly handle 1000 or more publications that are available (or not) according to public access mandates #414.
-- Fix errors in `download_mandates_csv` that may occassionally occur for agencies without a policy link #413.
+- Fix errors in `download_mandates_csv` that may occasionally occur for agencies without a policy link #413.
 
 ## Changes in v1.6.3
 
@@ -35,7 +35,7 @@
 
 ### Features
 - Download table of funding agencies as a CSV file with URL to the funding mandates included
-- Downlad top-ranking journals in general, under sub-categories and in different languages as a CSV file
+- Download top-ranking journals in general, under sub-categories and in different languages as a CSV file
 
 ### Bugfixes
 - #392
@@ -58,7 +58,7 @@
 ## Changes in v1.5.0
 ### Features
 - Fetch the public access mandates information from a Scholar profile and mark the publications whether or not they satisfy the open-access mandate.
-- Fetch an author's organization identifer from their Scholar profile
+- Fetch an author's organization identifier from their Scholar profile
 - Search for all authors affiliated with an organization
 - Fetch homepage URL from a Scholar profile
 ### Enhancements

README.md

@@ -53,7 +53,7 @@ This means your code that uses an earlier version of `scholarly` is guaranteed t
 
 ## Tests
 
-To check if your installation is succesful, run the tests by executing the `test_module.py` file as:
+To check if your installation is successful, run the tests by executing the `test_module.py` file as:
 
 ```bash
 python3 test_module

scholarly/_proxy_generator.py

@@ -109,15 +109,15 @@ def SingleProxy(self, http=None, https=None):
 
         :param http: http proxy address
         :type http: string
-        :param https: https proxy adress
+        :param https: https proxy address
         :type https: string
         :returns: whether or not the proxy was set up successfully
         :rtype: {bool}
 
         :Example::
 
             >>> pg = ProxyGenerator()
-            >>> success = pg.SingleProxy(http = <http proxy adress>, https = <https proxy adress>)
+            >>> success = pg.SingleProxy(http = <http proxy address>, https = <https proxy address>)
         """
         self.logger.info("Enabling proxies: http=%s https=%s", http, https)
         proxy_works = self._use_proxy(http=http, https=https)
@@ -162,7 +162,7 @@ def _check_proxy(self, proxies) -> bool:
     def _refresh_tor_id(self, tor_control_port: int, password: str) -> bool:
         """Refreshes the id by using a new Tor node.
 
-        :returns: Whether or not the refresh was succesful
+        :returns: Whether or not the refresh was successful
         :rtype: {bool}
         """
         try:
@@ -434,7 +434,7 @@ def _handle_captcha2(self, url):
                 self.logger.info("Google thinks we are DOSing the captcha.")
                 raise e
             except (WebDriverException) as e:
-                self.logger.info("Browser seems to be disfunctional - closed by user?")
+                self.logger.info("Browser seems to be dysfunctional - closed by user?")
                 raise e
             except Exception as e:
                 # TODO: This exception handler should eventually be removed when
@@ -500,7 +500,7 @@ def _close_session(self):
                 self.logger.warning("Could not close webdriver cleanly: %s", e)
 
     def _fp_coroutine(self, timeout=1, wait_time=120):
-        """A coroutine to continuosly yield free proxies
+        """A coroutine to continuously yield free proxies
 
         It takes back the proxies that stopped working and marks it as dirty.
         """

scholarly/_scholarly.py

@@ -428,7 +428,7 @@ def search_pubs_custom_url(self, url: str)->_SearchScholarIterator:
         parameters in the Advanced Search dialog box and then use the URL here
         to programmatically fetch the results.
 
-        :param url: custom url to seach for the publication
+        :param url: custom url to search for the publication
         :type url: string
         """
         return self.__nav.search_publications(url)

scholarly/author_parser.py

@@ -222,7 +222,7 @@ def _get_coauthors_short(self, soup):
     def _get_coauthors_long(self, author):
         """Get the long (>20) list of coauthors.
 
-        This method fetches the complete list of coauthors bu opening a new
+        This method fetches the complete list of coauthors by opening a new
         page filled with the complete coauthor list.
 
         Note:
@@ -283,7 +283,7 @@ def fill(self, author, sections: list = [], sortby="citedby", publication_limit:
         :type sortby: string
         :param publication_limit: Select the max number of publications you want you want to fill for the author. Defaults to no limit.
         :type publication_limit: int
-        :returns: The filled object if fill was successfull, False otherwise.
+        :returns: The filled object if fill was successful, False otherwise.
         :rtype: Author or bool
 
         :Example::

scholarly/data_types.py

@@ -49,7 +49,7 @@ class PublicationSource(str, Enum):
     We also have publications that appear in the "author pages" of Google Scholar.
     These publications are often a set of publications "merged" together.
 
-    The snippet version of these publications conains the title of the publication,
+    The snippet version of these publications contains the title of the publication,
     a subset of the authors, the (sometimes truncated) venue, and the year of the publication
     and the number of papers that cite the publication.
 
@@ -183,7 +183,7 @@ class Publication(TypedDict, total=False):
                        the "citedby_url" will be a comma-separated list of values.
                        It is also used to return the "cluster" of all the different versions of the paper.
                        https://scholar.google.com/scholar?cluster=16766804411681372720&hl=en
-    :param cites_per_year: a dictionay containing the number of citations per year for this Publication
+    :param cites_per_year: a dictionary containing the number of citations per year for this Publication
                            (source: AUTHOR_PUBLICATION_ENTRY)
     :param eprint_url: digital version of the Publication. Usually it is a pdf.
     :param pub_url: url of the website providing the publication

test_module.py

@@ -244,7 +244,7 @@ def test_search_author_multiple_authors(self):
     def test_search_author_id(self):
         """
         Test the search by author ID. Marie Skłodowska-Curie's ID is
-        EmD_lTEAAAAJ and these IDs are permenant
+        EmD_lTEAAAAJ and these IDs are permanent
         """
         author = scholarly.search_author_id('EmD_lTEAAAAJ')
         self.assertEqual(author['name'], u'Marie Skłodowska-Curie')
@@ -254,7 +254,7 @@ def test_search_author_id(self):
     def test_search_author_id_filled(self):
         """
         Test the search by author ID. Marie Skłodowska-Curie's ID is
-        EmD_lTEAAAAJ and these IDs are permenant.
+        EmD_lTEAAAAJ and these IDs are permanent.
         As of July 2020, Marie Skłodowska-Curie has 1963 citations
         on Google Scholar and 179 publications
         """