Merge pull request #847 from kianmeng/fix-typos

Fix typos

INSTALL

@@ -55,7 +55,7 @@ Environment variables that affect "make install":
     The full path to the lib directory.
     Default: ``EPREFIX/lib``
   DATADIR
-    The full path to non-arcitecture dependent data files.
+    The full path to non-architecture dependent data files.
     Default: ``PREFIX/share``
   MANPREFIX
     The full path to the parent of the man page installation directory (same
@@ -84,5 +84,3 @@ Environment variables that affect "make install":
 
 Additional Resources:
 1. `XDG Base Directory Specification <https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_
-
-

doc/dev/debugging.rst

@@ -175,7 +175,7 @@ Debugging segfaults (segmentation violations)
 3. Run ``gdb /usr/bin/python3``
 4. In gdb, run ``set logging on exaile-segfault.txt`` to enable logging to that file.
 5. In gdb, run ``run ./exaile.py --startgui``. You might append other arguments if you need them.
-6. Use Exaile as you did before and try to reproduce the problem. At some point, exaile might freeze. This is when gdb catched the segmentation fault.
+6. Use Exaile as you did before and try to reproduce the problem. At some point, exaile might freeze. This is when gdb caught the segmentation fault.
 7. In gdb, run ``t a a py-bt`` and ``t a a bt full``. The first one will get python backtraces from all threads, the second one will get native (C/C++) stacktraces. You might need to type the return key a few times after each of these two commands to make gdb print all lines of the stack traces. This might take a while.
 8. In gdb, type ``quit`` and press the enter key.
 9. Please attach the file ``exaile-segfault.txt`` to a bug report at `Github <https://github.com/exaile/exaile/issues/new>`_ after you checked that it does not contain any private data. If you prefer to send the data encrypted, please feel free to encrypt them to the PGP key ID 0x545B42FB8713DA3B and send it to one of its Email addresses.

doc/dev/plugin_guide.rst

@@ -401,7 +401,7 @@ of trying to explain it:
     settings.set_option('plugin/pluginname/settingname', setting_value)
     
     #to get a setting
-    default_value = 'If the setting doesnt exist, I am the default value.'
+    default_value = 'If the setting doesn't exist, I am the default value.'
     retrieved_setting = settings.get_option('plugin/pluginname/settingname', default_value)
 
 That's all there is to it. There is a few restrictions as to the
@@ -410,7 +410,7 @@ datatypes you can save as settings, see ``xl/settings.py`` for more details.
 Searching the collection
 -------------------------
 
-The following method returns an list of similiar tracks to the current
+The following method returns an list of similar tracks to the current
 playing track:
 
 .. code-block:: python

plugins/bookmarks/__init__.py

@@ -52,7 +52,7 @@ def __init__(
     ):
         """
         Creates a bookmark for current track/position if path or time are
-        None. Creates a bookmark for the given track/positon otherwise.
+        None. Creates a bookmark for the given track/position otherwise.
         """
         if not path:
             # get currently playing track

plugins/currentsong/PLUGININFO

@@ -1,6 +1,6 @@
 Version='4.1.2'
 Authors=['Aly Hirani <alyhirani@gmail.com>', 'Jorge Villaseñor <salinasv@gmail.com']
 Name=_('Current Song in Pidgin')
-Description=_('Sets the currently playing status in Pidgin. Check the Pidgin FAQ to find out the suppported services.')
+Description=_('Sets the currently playing status in Pidgin. Check the Pidgin FAQ to find out the supported services.')
 Category=_('Notifications')
 RequiredModules=['dbus']

plugins/daapclient/__init__.py

@@ -603,7 +603,7 @@ def rescan(self, notify_interval=None, force_update=False):
         self.scanning = False
         # return True
 
-    # Needed to be overriden for who knows why (exceptions)
+    # Needed to be overridden for who knows why (exceptions)
     def _count_files(self):
         count = 0
         if self.daap_share:

plugins/daapclient/client.py

@@ -252,7 +252,7 @@ def __getattr__(self, name):
 
     def request(self):
         """returns a 'response' object for the track's mp3 data.
-        presumably you can strem from this or something"""
+        presumably you can stream from this or something"""
 
         # gotta bump this every track download
         self.database.session.connection.request_id += 1

plugins/grouptagger/__init__.py

@@ -120,7 +120,7 @@ def on_gui_loaded(self):
             menu.simple_menu_item(
                 'gt_export',
                 [],
-                _('E_xport collecton tags to JSON'),
+                _('E_xport collection tags to JSON'),
                 callback=self.on_export_tags,
             )
         )

plugins/helloworld/__init__.py

@@ -30,7 +30,7 @@
 
         def enable(exaile):
             print("Hello, world!")
-            testlib.sucess()
+            testlib.success()
 
         def disable(exaile):
             print("Goodbye. :(")
@@ -82,7 +82,7 @@ def on_plugin_installed(self):
 
     def enable(self, exaile):
         print("Hello, world!")
-        testlib.sucess()
+        testlib.success()
 
     def disable(self, exaile):
         print("Goodbye. :(")

plugins/helloworld/testlib.py

@@ -25,5 +25,5 @@
 # from your version.
 
 
-def sucess():
+def success():
     print("w00t!")

plugins/inhibitsuspend/__init__.py

@@ -229,7 +229,7 @@ class PowerManagerAdapter(DbusSuspendAdapter):
     """
     Default Adapter, implemented by most desktop sessions
     Adapter for org.freedesktop.PowerManagement.Inhibit Interface
-    Some desktop sesssions use different bus names for this interface
+    Some desktop sessions use different bus names for this interface
     and have other small variances
     """
 
@@ -266,7 +266,7 @@ def __init__(self):
 
     def _dbus_inhibit_call(self):
         """
-        Gnome Interface has more paramters
+        Gnome Interface has more parameters
         """
         self.cookie = self.iface.Inhibit(
             self.PROGRAM, 1, self.ACTIVITY, self.SUSPEND_FLAG

plugins/ipconsole/ipython_view.py

@@ -290,7 +290,7 @@ def historyForward(self):
 
     def _getHistory(self):
         """
-        Get's the command string of the current history level.
+        Gets the command string of the current history level.
 
         @return: Historic command string.
         @rtype: string
@@ -652,7 +652,7 @@ def __init__(self):
 
     def raw_input(self, prompt=''):
         """
-        Custom raw_input() replacement. Get's current line from console buffer.
+        Custom raw_input() replacement. Gets current line from console buffer.
 
         @param prompt: Prompt to print. Here for compatibility as replacement.
         @type prompt: string

plugins/jamendo/__init__.py

@@ -89,7 +89,7 @@ def __init__(self, parent, exaile):
 
         self.setup_widgets()
 
-    # find out whats selected and add the tracks under it to the playlist
+    # find out what's selected and add the tracks under it to the playlist
     def add_to_playlist(self):
         sel = self.get_selected_item()
         if isinstance(sel, jamtree.Artist):
@@ -440,7 +440,7 @@ class JamendoCoverSearch(CoverSearchMethod):
     name = 'jamendo'
     use_cache = False  # do this since the tracks dont stay on local.
     fixed = True
-    fixed_priority = 5  # take precendence, since we know we are 'right'
+    fixed_priority = 5  # take precedence, since we know we are 'right'
     # for matching tracks.
 
     def __init__(self, user_agent):

plugins/lastfmlove/lastfmlove_preferences.py

@@ -39,7 +39,7 @@ class APIKeyPreference(widgets.Preference):
     name = 'plugin/lastfmlove/api_key'
 
 
-class APISecretPrefence(widgets.Preference):
+class APISecretPreference(widgets.Preference):
     name = 'plugin/lastfmlove/api_secret'
 
 

plugins/minimode/__init__.py

@@ -271,7 +271,7 @@ def on_mainbutton_clicked(self, button):
 
     def on_main_visible_toggle(self, main):
         """
-        Handles visiblity toggles in
+        Handles visibility toggles in
         Exaile's main window stead
         """
         if self.__active:

plugins/multialarmclock/__init__.py

@@ -47,7 +47,7 @@ def _init(prefsdialog, builder):
     logger.debug('_init() called')
     global MY_BUILDER, ALARM_CLOCK_MAIN
 
-    # note that we get a new builder everytime the prefs dialog is closed and re-opened
+    # note that we get a new builder every time the prefs dialog is closed and re-opened
     MY_BUILDER = builder
     if ALARM_CLOCK_MAIN is not None:
         ALARM_CLOCK_MAIN.init_ui(builder)

plugins/multialarmclock/cellrenderers.py

@@ -133,7 +133,7 @@ def _done(self):
 
     def _key_pressed(self, view, event):
         '''Key pressed event handler, finish editing on Return'''
-        # event == None for day selected via doubleclick
+        # event == None for day selected via double-click
         if (
             not event
             or event.type == Gdk.EventType.KEY_PRESS

plugins/osd/__init__.py

@@ -384,7 +384,7 @@ def __setup_resize_move_related_stuff(self, allow_resize_move):
         # Without decorations, the window cannot be resized on some desktops
         # this especially effects GNOME/Wayland and is probably caused by
         # missing client-side decorations (CSD). This code might break when
-        # using client side decorations. In this case, we probably shoud hide
+        # using client side decorations. In this case, we probably should hide
         # the titlebar instead of removing the decorations.
         # Removing decorations is ignored on some platforms to enable
         # the resize grid.

plugins/playlistanalyzer/extending.txt

@@ -43,7 +43,7 @@ The plugin treats the template as a giant string, and uses python format
 string functionality to substitute data into the template. 
 
 - Anything with a % in it should be %%
-- The following special strings will be subsituted
+- The following special strings will be substituted
 
     - %(data)s              - The data as JSON (see above for format)
     - %(title)s             - User defined title

plugins/replaygain/__init__.py

@@ -35,7 +35,7 @@
     def get_preferences_pane():
         return replaygainprefs
 
-except Exception:  # fail gracefully if we cant set up the UI
+except Exception:  # fail gracefully if we can't set up the UI
     pass
 
 NEEDED_ELEMS = ["rgvolume", "rglimiter"]

plugins/shutdown/__init__.py

@@ -57,7 +57,7 @@ def __init__(self, exaile):
 
     def on_toggled(self, menuitem):
         """
-        Enables or disables defered shutdown
+        Enables or disables deferred shutdown
         """
         if menuitem.get_active():
             self.do_shutdown = True

tests/xl/trax/test_track.py

@@ -517,7 +517,7 @@ def test_get_display_tag_bitrate(self):
         tr.set_tag_raw('__bitrate', 48000)
         assert tr.get_tag_display('__bitrate') == '48k'
 
-    def test_get_display_tag_bitrate_bitrateless_formate(self, test_tracks):
+    def test_get_display_tag_bitrate_bitrateless_format(self, test_tracks):
         td = test_tracks.get('.flac')
         tr = track.Track(td.filename)
         assert tr.get_tag_display('__bitrate') == ''

tools/installer/exaile_installer.nsi

@@ -191,13 +191,13 @@ Function .onInit
             ; if it returns success proceede, otherwise abort the installer
             ; (uninstall aborted by user for example)
             ExecWait '"$INSTDIR\uninstall.exe" _?=$INSTDIR' $R1
-            ; uninstall suceeded, since the uninstall.exe is still there
+            ; uninstall succeeded, since the uninstall.exe is still there
             ; goto rm_instdir as well
             StrCmp $R1 0 rm_instdir
             ; uninstall failed
             Abort
         rm_instdir:
-            ; either the uninstaller was sucessfull or
+            ; either the uninstaller was successful or
             ; the uninstaller.exe wasn't found
             RMDir /r "$INSTDIR"
     do_continue:

tools/pylint.cfg

@@ -70,12 +70,12 @@ include-ids=yes
 # written in a file name "pylint_global.[txt|html]".
 files-output=no
 
-# Tells wether to display a full report or only the messages
+# Tells whether to display a full report or only the messages
 reports=no
 
 # Python expression which should return a note less than 10 (10 is the highest
 # note). You have access to the variables errors warning, statement which
-# respectivly contain the number of errors / warnings messages and the total
+# respectively contain the number of errors / warnings messages and the total
 # number of statements analyzed. This is used by the global evaluation report
 # (R0004).
 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
@@ -94,7 +94,7 @@ comment=no
 # checks for :
 # * doc strings
 # * modules / classes / functions / methods / arguments / variables name
-# * number of arguments, local variables, branchs, returns and statements in
+# * number of arguments, local variables, branches, returns and statements in
 # functions, methods
 # * required module attributes
 # * dangerous default values as arguments
@@ -152,11 +152,11 @@ bad-functions=map,filter,apply,input
 # * unused variables / imports
 # * undefined variables
 # * redefinition of variable from builtins or from an outer scope
-# * use of variable before assigment
+# * use of variable before assignment
 # 
 [VARIABLES]
 
-# Tells wether we should check for unused import in __init__ files.
+# Tells whether we should check for unused import in __init__ files.
 init-import=no
 
 # A regular expression matching names used for dummy variables (i.e. not used).
@@ -171,12 +171,12 @@ additional-builtins=
 # 
 [TYPECHECK]
 
-# Tells wether missing members accessed in mixin class should be ignored. A
+# Tells whether missing members accessed in mixin class should be ignored. A
 # mixin class is detected if its name ends with "mixin" (case insensitive).
 ignore-mixin-members=yes
 
 # List of classes names for which member attributes should not be checked
-# (useful for classes with attributes dynamicaly set).
+# (useful for classes with attributes dynamically set).
 ignored-classes=SQLObject
 
 # When zope mode is activated, add a predefined set of Zope acquired attributes
@@ -225,7 +225,7 @@ max-public-methods=20
 # checks for :
 # * methods without self as first argument
 # * overridden methods signature
-# * access only to existant members via self
+# * access only to existent members via self
 # * attributes not defined in the __init__ method
 # * supported interfaces implementation
 # * unreachable code

xl/collection.py

@@ -261,7 +261,7 @@ def rescan_libraries(self, startup_only=False, force_update=False):
             self._running_total_count += self._running_count
             if self._scan_stopped:
                 break
-        else:  # didnt break
+        else:  # didn't break
             try:
                 if self.location is not None:
                     self.save_to_location()
@@ -734,7 +734,7 @@ def update_track(
                 self.collection.add(tr)
 
             # Track already existed. This fixes trax.get_tracks_from_uri
-            # on windows, unknown why fix isnt needed on linux.
+            # on windows, unknown why fix isn't needed on linux.
             elif not tr._init:
                 self.collection.add(tr)
         return tr
@@ -801,7 +801,7 @@ def rescan(
                     # for compilation detection. Most albums have far fewer
                     # than 110 tracks anyway, so it is unlikely that this
                     # restriction will affect the heuristic's accuracy.
-                    # 110 was chosen to accomodate "top 100"-style
+                    # 110 was chosen to accommodate "top 100"-style
                     # compilations.
                     if len(dirtracks) > 110:
                         logger.debug(
@@ -909,7 +909,7 @@ def dequeue(self, tracks: Iterable[trax.Track]) -> None:
 
     def transfer(self) -> None:
         """
-        Tranfer the queued tracks to the library.
+        Transfer the queued tracks to the library.
 
         This is NOT asynchronous
         """

xl/common.py

@@ -276,7 +276,7 @@ def glib_wait_seconds(timeout):
     """
     Same as glib_wait, but uses GLib.timeout_add_seconds instead
     of GLib.timeout_add and takes its timeout in seconds. See the
-    glib documention for why you might want to use one over the
+    glib documentation for why you might want to use one over the
     other.
     """
     return _glib_wait_inner(timeout, GLib.timeout_add_seconds)
@@ -571,7 +571,7 @@ def walk(root: Gio.File) -> Iterable[Gio.File]:
                     queue.append(fil)
                 elif type == Gio.FileType.REGULAR:
                     yield fil
-        except GLib.Error:  # why doesnt gio offer more-specific errors?
+        except GLib.Error:  # why doesn't gio offer more-specific errors?
             logger.exception("Unhandled exception while walking on %s.", dir)
 
 

xl/covers.py

@@ -73,7 +73,7 @@ def add(self, data):
 
         :param data: The data to store, as a bytestring.
         """
-        # FIXME: this doesnt handle hash collisions at all. with
+        # FIXME: this doesn't handle hash collisions at all. with
         # 2^256 possible keys its unlikely that we'll have a collision,
         # but we should handle it anyway.
         h = hashlib.sha256()
@@ -484,7 +484,7 @@ class CoverSearchMethod:
 
     #: If true, cover results will be cached for faster lookup
     use_cache = True
-    #: A name uniquely identifing the search method.
+    #: A name uniquely identifying the search method.
     name = "base"
     #: Whether the backend should have a fixed priority instead of being
     #  configurable.