8000 Merge pull request #539 from bryant1410/typos · SuperJarek/GitPython@afcd64e · GitHub
[go: up one dir, main page]
Skip to content

Commit afcd64e

Browse files
ankostisankostis
authored
Merge pull request gitpython-developers#539 from bryant1410/typos
Fix some typos
2 parents aab7dc2 + 66c41eb commit afcd64e

File tree

25 files changed

+79
-80
lines changed
  • README.md
  • < 8000 div class="PRIVATE_VisuallyHidden prc-TreeView-TreeViewVisuallyHidden-4-mPv" aria-hidden="true" id=":R1lddabH1:">
    doc/source
  • git

    • 25 files changed

    +79
    -80
    lines changed

    ‎README.md

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -83,7 +83,7 @@ exists in `Git\mingw64\libexec\git-core\`; CYGWIN has no daemon, but should get
    8383
    with MINGW's.
    8484

    8585
    The easiest way to run tests is by using [tox](https://pypi.python.org/pypi/tox)
    86-
    a wrapper around virtualenv. It will take care of setting up environnements with the proper
    86+
    a wrapper around virtualenv. It will take care of setting up environments with the proper
    8787
    dependencies installed and execute test commands. To install it simply:
    8888

    8989
    pip install tox

    ‎doc/source/changes.rst

    Lines changed: 14 additions & 14 deletions
    Original file line numberDiff line numberDiff line change
    @@ -185,11 +185,11 @@ It follows the `semantic version scheme <http://semver.org>`_, and thus will not
    185185

    186186
    0.3.3
    187187
    =====
    188-
    * When fetching, pulling or pushing, and an error occours, it will not be reported on stdout anymore. However, if there is a fatal error, it will still result in a GitCommandError to be thrown. This goes hand in hand with improved fetch result parsing.
    188+
    * When fetching, pulling or pushing, and an error occurs, it will not be reported on stdout anymore. However, if there is a fatal error, it will still result in a GitCommandError to be thrown. This goes hand in hand with improved fetch result parsing.
    189189
    * Code Cleanup (in preparation for python 3 support)
    190190

    191191
    * Applied autopep8 and cleaned up code
    192-
    * Using python logging module instead of print statments to signal certain kinds of errors
    192+
    * Using python logging module instead of print statements to signal certain kinds of errors
    193193

    194194
    0.3.2.1
    195195
    =======
    A3E2
    @@ -268,7 +268,7 @@ It follows the `semantic version scheme <http://semver.org>`_, and thus will not
    268268
    * Head Type changes
    269269

    270270
    * config_reader() & config_writer() methods added for access to head specific options.
    271-
    * tracking_branch() & set_tracking_branch() methods addded for easy configuration of tracking branches.
    271+
    * tracking_branch() & set_tracking_branch() methods added for easy configuration of tracking branches.
    272272

    273273

    274274
    0.3.0 Beta 2
    @@ -300,13 +300,13 @@ General
    300300
    0.2 Beta 2
    301301
    ===========
    302302
    * Commit objects now carry the 'encoding' information of their message. It wasn't parsed previously, and defaults to UTF-8
    303-
    * Commit.create_from_tree now uses a pure-python implementation, mimicing git-commit-tree
    303+
    * Commit.create_from_tree now uses a pure-python implementation, mimicking git-commit-tree
    304304

    305305
    0.2
    306306
    =====
    307307
    General
    308308
    -------
    309-
    * file mode in Tree, Blob and Diff objects now is an int compatible to definintiions
    309+
    * file mode in Tree, Blob and Diff objects now is an int compatible to definitions
    310310
    in the stat module, allowing you to query whether individual user, group and other
    311311
    read, write and execute bits are set.
    312312
    * Adjusted class hierarchy to generally allow comparison and hash for Objects and Refs
    @@ -320,12 +320,12 @@ General
    320320
    may change without prior notice.
    321321
    * Renamed all find_all methods to list_items - this method is part of the Iterable interface
    322322
    that also provides a more efficients and more responsive iter_items method
    323-
    * All dates, like authored_date and committer_date, are stored as seconds since epoc
    323+
    * All dates, like authored_date and committer_date, are stored as seconds since epoch
    324324
    to consume less memory - they can be converted using time.gmtime in a more suitable
    325325
    presentation format if needed.
    326326
    * Named method parameters changed on a wide scale to unify their use. Now git specific
    327327
    terms are used everywhere, such as "Reference" ( ref ) and "Revision" ( rev ).
    328-
    Prevously multiple terms where used making it harder to know which type was allowed
    328+
    Previously multiple terms where used making it harder to know which type was allowed
    329329
    or not.
    330330
    * Unified diff interface to allow easy diffing between trees, trees and index, trees
    331331
    and working tree, index and working tree, trees and index. This closely follows
    @@ -355,7 +355,7 @@ Blob
    355355
    GitCommand
    356356
    -----------
    357357
    * git.subcommand call scheme now prunes out None from the argument list, allowing
    358-
    to be called more confortably as None can never be a valid to the git command
    358+
    to be called more comfortably as None can never be a valid to the git command
    359359
    if converted to a string.
    360360
    * Renamed 'git_dir' attribute to 'working_dir' which is exactly how it is used
    361361

    @@ -382,19 +382,19 @@ Diff
    382382
    Diffing
    383383
    -------
    384384
    * Commit and Tree objects now support diffing natively with a common interface to
    385-
    compare agains other Commits or Trees, against the working tree or against the index.
    385+
    compare against other Commits or Trees, against the working tree or against the index.
    386386

    387387
    Index
    388388
    -----
    389389
    * A new Index class allows to read and write index files directly, and to perform
    390390
    simple two and three way merges based on an arbitrary index.
    391391

    392-
    Referernces
    392+
    References
    393393
    ------------
    394394
    * References are object that point to a Commit
    395395
    * SymbolicReference are a pointer to a Reference Object, which itself points to a specific
    396396
    Commit
    397-
    * They will dynmically retrieve their object at the time of query to assure the information
    397+
    * They will dynamically retrieve their object at the time of query to assure the information
    398398
    is actual. Recently objects would be cached, hence ref object not be safely kept
    399399
    persistent.
    400400

    @@ -403,7 +403,7 @@ Repo
    403403
    * Moved blame method from Blob to repo as it appeared to belong there much more.
    404404
    * active_branch method now returns a Head object instead of a string with the name
    405405
    of the active branch.
    406-
    * tree method now requires a Ref instance as input and defaults to the active_branche
    406+
    * tree method now requires a Ref instance as input and defaults to the active_branch
    407407
    instead of master
    408408
    * is_dirty now takes additional arguments allowing fine-grained control about what is
    409409
    considered dirty
    @@ -479,7 +479,7 @@ General
    479479
    * Removed ambiguity between paths and treeishs. When calling commands that
    480480
    accept treeish and path arguments and there is a path with the same name as
    481481
    a treeish git cowardly refuses to pick one and asks for the command to use
    482-
    the unambiguous syntax where '--' seperates the treeish from the paths.
    482+
    the unambiguous syntax where '--' separates the treeish from the paths.
    483483

    484484
    * ``Repo.commits``, ``Repo.commits_between``, ``Repo.commits_since``,
    485485
    ``Repo.commit_count``, ``Repo.commit``, ``Commit.count`` and
    @@ -627,7 +627,7 @@ Tree
    627627
    ----
    628628
    * Corrected problem with ``Tree.__div__`` not working with zero length files.
    629629
    Removed ``__len__`` override and replaced with size instead. Also made size
    630-
    cach properly. This is a breaking change.
    630+
    cache properly. This is a breaking change.
    631631

    632632
    0.1.1
    633633
    =====

    ‎doc/source/intro.rst

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -92,7 +92,7 @@ Getting Started
    9292
    API Reference
    9393
    =============
    9494

    95-
    An organized section of the GitPthon API is at :ref:`api_reference_toplevel`.
    95+
    An organized section of the GitPython API is at :ref:`api_reference_toplevel`.
    9696

    9797
    .. _source-code-label:
    9898

    ‎git/cmd.py

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -68,10 +68,10 @@ def handle_process_output(process, stdout_handler, stderr_handler,
    6868
    :return: result of finalizer
    6969
    :param process: subprocess.Popen instance
    7070
    :param stdout_handler: f(stdout_line_string), or None
    71-
    :param stderr_hanlder: f(stderr_line_string), or None
    71+
    :param stderr_handler: f(stderr_line_string), or None
    7272
    :param finalizer: f(proc) - wait for proc to finish
    7373
    :param decode_streams:
    74-
    Assume stdout/stderr streams are binary and decode them vefore pushing \
    74+
    Assume stdout/stderr streams are binary and decode them before pushing \
    7575
    their contents to handlers.
    7676
    Set it to False if `universal_newline == True` (then streams are in text-mode)
    7777
    or if decoding must happen later (i.e. for Diffs).
    @@ -419,7 +419,7 @@ def set_persistent_git_options(self, **kwargs):
    419419

    420420
    def _set_cache_(self, attr):
    421421
    if attr == '_version_info':
    422-
    # We only use the first 4 numbers, as everthing else could be strings in fact (on windows)
    422+
    # We only use the first 4 numbers, as everything else could be strings in fact (on windows)
    423423
    version_numbers = self._call_process('version').split(' ')[2]
    424424
    self._version_info = tuple(int(n) for n in version_numbers.split('.')[:4] if n.isdigit())
    425425
    else:

    ‎git/config.py

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -194,7 +194,7 @@ def __init__(self, file_or_files, read_only=True, merge_includes=True):
    194194
    configuration files have been included
    195195
    :param merge_includes: if True, we will read files mentioned in [include] sections and merge their
    196196
    contents into ours. This makes it impossible to write back an individual configuration file.
    197-
    Thus, if you want to modify a single conifguration file, turn this off to leave the original
    197+
    Thus, if you want to modify a single configuration file, turn this off to leave the original
    198198
    dataset unaltered when reading it."""
    199199
    cp.RawConfigParser.__init__(self, dict_type=OrderedDict)
    200200

    @@ -271,7 +271,7 @@ def _read(self, fp, fpname):
    271271
    """A direct copy of the py2.4 version of the super class's _read method
    272272
    to assure it uses ordered dicts. Had to change one line to make it work.
    273273
    274-
    Future versions have this fixed, but in fact its quite embarassing for the
    274+
    Future versions have this fixed, but in fact its quite embarrassing for the
    275275
    guys not to have done it right in the first place !
    276276
    277277
    Removed big comments to make it more compact.
    @@ -468,7 +468,7 @@ def write(self):
    468468
    # end assert multiple files
    469469

    470470
    if self._has_includes():
    471-
    log.debug("Skipping write-back of confiuration file as include files were merged in." +
    471+
    log.debug("Skipping write-back of configuration file as include files were merged in." +
    472472
    "Set merge_includes=False to prevent this.")
    473473
    return
    474474
    # end

    ‎git/diff.py

    Lines changed: 7 additions & 7 deletions
    Original file line numberDiff line numberDiff line change
    @@ -91,11 +91,11 @@ def diff(self, other=Index, paths=None, create_patch=False, **kwargs):
    9191
    9292
    :param paths:
    9393
    is a list of paths or a single path to limit the diff to.
    94-
    It will only include at least one of the givne path or paths.
    94+
    It will only include at least one of the given path or paths.
    9595
    9696
    :param create_patch:
    9797
    If True, the returned Diff contains a detailed patch that if applied
    98-
    makes the self to other. Patches are somwhat costly as blobs have to be read
    98+
    makes the self to other. Patches are somewhat costly as blobs have to be read
    9999
    and diffed.
    100100
    101101
    :param kwargs:
    @@ -106,7 +106,7 @@ def diff(self, other=Index, paths=None, create_patch=False, **kwargs):
    106106
    107107
    :note:
    108108
    On a bare repository, 'other' needs to be provided as Index or as
    109-
    as Tree/Commit, or a git command error will occour"""
    109+
    as Tree/Commit, or a git command error will occur"""
    110110
    args = list()
    111111
    args.append("--abbrev=40") # we need full shas
    112112
    args.append("--full-index") # get full index paths, not only filenames
    @@ -172,7 +172,7 @@ class DiffIndex(list):
    172172
    def iter_change_type(self, change_type):
    173173
    """
    174174
    :return:
    175-
    iterator yieling Diff instances that match the given change_type
    175+
    iterator yielding Diff instances that match the given change_type
    176176
    177177
    :param change_type:
    178178
    Member of DiffIndex.change_type, namely:
    @@ -347,7 +347,7 @@ def __str__(self):
    347347
    msg += '\n---'
    348348
    # END diff info
    349349

    350-
    # Python2 sillyness: have to assure we convert our likely to be unicode object to a string with the
    350+
    # Python2 silliness: have to assure we convert our likely to be unicode object to a string with the
    351351
    # right encoding. Otherwise it tries to convert it using ascii, which may fail ungracefully
    352352
    res = h + msg
    353353
    if not PY3:
    @@ -427,7 +427,7 @@ def _index_from_patch_format(cls, repo, proc):
    427427
    b_path = cls._pick_best_path(b_path, rename_to, b_path_fallback)
    428428

    429429
    # Our only means to find the actual text is to see what has not been matched by our regex,
    430-
    # and then retro-actively assin it to our index
    430+
    # and then retro-actively assign it to our index
    431431
    if previous_header is not None:
    432432
    index[-1].diff = text[previous_header.end():header.start()]
    433433
    # end assign actual diff
    @@ -480,7 +480,7 @@ def handle_diff_line(line):
    480480
    rename_from = None
    481481
    rename_to = None
    482482

    483-
    # NOTE: We cannot conclude from the existance of a blob to change type
    483+
    # NOTE: We cannot conclude from the existence of a blob to change type
    484484
    # as diffs with the working do not have blobs yet
    485485
    if change_type == 'D':
    486486
    b_blob_id = None

    ‎git/exc.py

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -3,7 +3,7 @@
    33
    #
    44
    # This module is part of GitPython and is released under
    55
    # the BSD License: http://www.opensource.org/licenses/bsd-license.php
    6-
    """ Module containing all exceptions thrown througout the git package, """
    6+
    """ Module containing all exceptions thrown throughout the git package, """
    77

    88
    from gitdb.exc import * # NOQA @UnusedWildImport
    99
    from git.compat import UnicodeMixin, safe_decode, string_types

    ‎git/index/base.py

    Lines changed: 6 additions & 6 deletions
    10000
    Original file line numberDiff line numberDiff line change
    @@ -144,7 +144,7 @@ def _set_cache_(self, attr):
    144144
    self._deserialize(stream)
    145145
    finally:
    146146
    lfd.rollback()
    147-
    # The handles will be closed on desctruction
    147+
    # The handles will be closed on destruction
    148148
    # END read from default index on demand
    149149
    else:
    150150
    super(IndexFile, self)._set_cache_(attr)
    @@ -880,7 +880,7 @@ def remove(self, items, working_tree=False, **kwargs):
    880880
    def move(self, items, skip_errors=False, **kwargs):
    881881
    """Rename/move the items, whereas the last item is considered the destination of
    882882
    the move operation. If the destination is a file, the first item ( of two )
    883-
    must be a file as well. If the destination is a directory, it may be preceeded
    883+
    must be a file as well. If the destination is a directory, it may be preceded
    884884
    by one or more directories or files.
    885885
    886886
    The working tree will be affected in non-bare repositories.
    @@ -890,7 +890,7 @@ def move(self, items, skip_errors=False, **kwargs):
    890890
    for reference.
    891891
    :param skip_errors:
    892892
    If True, errors such as ones resulting from missing source files will
    893-
    be skpped.
    893+
    be skipped.
    894894
    :param kwargs:
    895895
    Additional arguments you would like to pass to git-mv, such as dry_run
    896896
    or force.
    @@ -899,7 +899,7 @@ def move(self, items, skip_errors=False, **kwargs):
    899899
    A list of pairs, containing the source file moved as well as its
    900900
    actual destination. Relative to the repository root.
    901901
    902-
    :raise ValueErorr: If only one item was given
    902+
    :raise ValueError: If only one item was given
    903903
    GitCommandError: If git could not handle your request"""
    904904
    args = list()
    905905
    if skip_errors:
    @@ -995,7 +995,7 @@ def checkout(self, paths=None, force=False, fprogress=lambda *args: None, **kwar
    995995
    prior and after a file has been checked out
    996996
    997997
    :param kwargs:
    998-
    Additional arguments to be pasesd to git-checkout-index
    998+
    Additional arguments to be passed to git-checkout-index
    999999
    10001000
    :return:
    10011001
    iterable yielding paths to files which have been checked out and are
    @@ -1223,7 +1223,7 @@ def diff(self, other=diff.Diffable.Index, paths=None, create_patch=False, **kwar
    12231223
    cur_val = kwargs.get('R', False)
    12241224
    kwargs['R'] = not cur_val
    12251225
    return other.diff(self.Index, paths, create_patch, **kwargs)
    1226-
    # END diff against other item handlin
    1226+
    # END diff against other item handling
    12271227

    12281228
    # if other is not None here, something is wrong
    12291229
    if other is not None:

    ‎git/index/fun.py

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -355,7 +355,7 @@ def aggressive_tree_merge(odb, tree_shas):
    355355
    out_append(_tree_entry_to_baseindexentry(theirs, 3))
    356356
    # END theirs changed
    357357
    # else:
    358-
    # theirs didnt change
    358+
    # theirs didn't change
    359359
    # pass
    360360
    # END handle theirs
    361361
    # END handle ours

    ‎git/index/util.py

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -72,7 +72,7 @@ def check_default_index(self, *args, **kwargs):
    7272
    raise AssertionError(
    7373
    "Cannot call %r on indices that do not represent the default git index" % func.__name__)
    7474
    return func(self, *args, **kwargs)
    75-
    # END wrpaper method
    75+
    # END wrapper method
    7676

    7777
    return check_default_index
    7878

    0 commit comments

    Comments
     (0)
    0