Skip to content

Fix some typos #539

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

Merged
merged 1 commit into from
Oct 20, 2016
Merged
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 @@ -83,7 +83,7 @@ exists in `Git\mingw64\libexec\git-core\`; CYGWIN has no daemon, but should get
with MINGW's.

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

pip install tox
Expand Down
28 changes: 14 additions & 14 deletions doc/source/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,11 @@ It follows the `semantic version scheme <http://semver.org>`_, and thus will not

0.3.3
=====
* 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.
* 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.
* Code Cleanup (in preparation for python 3 support)

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

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

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


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

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

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

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

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

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

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

0.1.1
=====
Expand Down
2 changes: 1 addition & 1 deletion doc/source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Getting Started
API Reference
=============

An organized section of the GitPthon API is at :ref:`api_reference_toplevel`.
An organized section of the GitPython API is at :ref:`api_reference_toplevel`.

.. _source-code-label:

Expand Down
6 changes: 3 additions & 3 deletions git/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ def handle_process_output(process, stdout_handler, stderr_handler,
:return: result of finalizer
:param process: subprocess.Popen instance
:param stdout_handler: f(stdout_line_string), or None
:param stderr_hanlder: f(stderr_line_string), or None
:param stderr_handler: f(stderr_line_string), or None
:param finalizer: f(proc) - wait for proc to finish
:param decode_streams:
Assume stdout/stderr streams are binary and decode them vefore pushing \
Assume stdout/stderr streams are binary and decode them before pushing \
their contents to handlers.
Set it to False if `universal_newline == True` (then streams are in text-mode)
or if decoding must happen later (i.e. for Diffs).
Expand Down Expand Up @@ -419,7 +419,7 @@ def set_persistent_git_options(self, **kwargs):

def _set_cache_(self, attr):
if attr == '_version_info':
# We only use the first 4 numbers, as everthing else could be strings in fact (on windows)
# We only use the first 4 numbers, as everything else could be strings in fact (on windows)
version_numbers = self._call_process('version').split(' ')[2]
self._version_info = tuple(int(n) for n in version_numbers.split('.')[:4] if n.isdigit())
else:
Expand Down
6 changes: 3 additions & 3 deletions git/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ def __init__(self, file_or_files, read_only=True, merge_includes=True):
configuration files have been included
:param merge_includes: if True, we will read files mentioned in [include] sections and merge their
contents into ours. This makes it impossible to write back an individual configuration file.
Thus, if you want to modify a single conifguration file, turn this off to leave the original
Thus, if you want to modify a single configuration file, turn this off to leave the original
dataset unaltered when reading it."""
cp.RawConfigParser.__init__(self, dict_type=OrderedDict)

Expand Down Expand Up @@ -271,7 +271,7 @@ def _read(self, fp, fpname):
"""A direct copy of the py2.4 version of the super class's _read method
to assure it uses ordered dicts. Had to change one line to make it work.

Future versions have this fixed, but in fact its quite embarassing for the
Future versions have this fixed, but in fact its quite embarrassing for the
guys not to have done it right in the first place !

Removed big comments to make it more compact.
Expand Down Expand Up @@ -468,7 +468,7 @@ def write(self):
# end assert multiple files

if self._has_includes():
log.debug("Skipping write-back of confiuration file as include files were merged in." +
log.debug("Skipping write-back of configuration file as include files were merged in." +
"Set merge_includes=False to prevent this.")
return
# end
Expand Down
14 changes: 7 additions & 7 deletions git/diff.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,11 @@ def diff(self, other=Index, paths=None, create_patch=False, **kwargs):

:param paths:
is a list of paths or a single path to limit the diff to.
It will only include at least one of the givne path or paths.
It will only include at least one of the given path or paths.

:param create_patch:
If True, the returned Diff contains a detailed patch that if applied
makes the self to other. Patches are somwhat costly as blobs have to be read
makes the self to other. Patches are somewhat costly as blobs have to be read
and diffed.

:param kwargs:
Expand All @@ -106,7 +106,7 @@ def diff(self, other=Index, paths=None, create_patch=False, **kwargs):

:note:
On a bare repository, 'other' needs to be provided as Index or as
as Tree/Commit, or a git command error will occour"""
as Tree/Commit, or a git command error will occur"""
args = list()
args.append("--abbrev=40") # we need full shas
args.append("--full-index") # get full index paths, not only filenames
Expand Down Expand Up @@ -172,7 +172,7 @@ class DiffIndex(list):
def iter_change_type(self, change_type):
"""
:return:
iterator yieling Diff instances that match the given change_type
iterator yielding Diff instances that match the given change_type

:param change_type:
Member of DiffIndex.change_type, namely:
Expand Down Expand Up @@ -347,7 +347,7 @@ def __str__(self):
msg += '\n---'
# END diff info

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

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

# NOTE: We cannot conclude from the existance of a blob to change type
# NOTE: We cannot conclude from the existence of a blob to change type
# as diffs with the working do not have blobs yet
if change_type == 'D':
b_blob_id = None
Expand Down
2 changes: 1 addition & 1 deletion git/exc.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# This module is part of GitPython and is released under
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
""" Module containing all exceptions thrown througout the git package, """
""" Module containing all exceptions thrown throughout the git package, """

from gitdb.exc import * # NOQA @UnusedWildImport
from git.compat import UnicodeMixin, safe_decode, string_types
Expand Down
12 changes: 6 additions & 6 deletions git/index/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ def _set_cache_(self, attr):
self._deserialize(stream)
finally:
lfd.rollback()
# The handles will be closed on desctruction
# The handles will be closed on destruction
# END read from default index on demand
else:
super(IndexFile, self)._set_cache_(attr)
Expand Down Expand Up @@ -880,7 +880,7 @@ def remove(self, items, working_tree=False, **kwargs):
def move(self, items, skip_errors=False, **kwargs):
"""Rename/move the items, whereas the last item is considered the destination of
the move operation. If the destination is a file, the first item ( of two )
must be a file as well. If the destination is a directory, it may be preceeded
must be a file as well. If the destination is a directory, it may be preceded
by one or more directories or files.

The working tree will be affected in non-bare repositories.
Expand All @@ -890,7 +890,7 @@ def move(self, items, skip_errors=False, **kwargs):
for reference.
:param skip_errors:
If True, errors such as ones resulting from missing source files will
be skpped.
be skipped.
:param kwargs:
Additional arguments you would like to pass to git-mv, such as dry_run
or force.
Expand All @@ -899,7 +899,7 @@ def move(self, items, skip_errors=False, **kwargs):
A list of pairs, containing the source file moved as well as its
actual destination. Relative to the repository root.

:raise ValueErorr: If only one item was given
:raise ValueError: If only one item was given
GitCommandError: If git could not handle your request"""
args = list()
if skip_errors:
Expand Down Expand Up @@ -995,7 +995,7 @@ def checkout(self, paths=None, force=False, fprogress=lambda *args: None, **kwar
prior and after a file has been checked out

:param kwargs:
Additional arguments to be pasesd to git-checkout-index
Additional arguments to be passed to git-checkout-index

:return:
iterable yielding paths to files which have been checked out and are
Expand Down Expand Up @@ -1223,7 +1223,7 @@ def diff(self, other=diff.Diffable.Index, paths=None, create_patch=False, **kwar
cur_val = kwargs.get('R', False)
kwargs['R'] = not cur_val
return other.diff(self.Index, paths, create_patch, **kwargs)
# END diff against other item handlin
# END diff against other item handling

# if other is not None here, something is wrong
if other is not None:
Expand Down
2 changes: 1 addition & 1 deletion git/index/fun.py
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ def aggressive_tree_merge(odb, tree_shas):
out_append(_tree_entry_to_baseindexentry(theirs, 3))
# END theirs changed
# else:
# theirs didnt change
# theirs didn't change
# pass
# END handle theirs
# END handle ours
Expand Down
2 changes: 1 addition & 1 deletion git/index/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def check_default_index(self, *args, **kwargs):
raise AssertionError(
"Cannot call %r on indices that do not represent the default git index" % func.__name__)
return func(self, *args, **kwargs)
# END wrpaper method
# END wrapper method

return check_default_index

Expand Down
6 changes: 3 additions & 3 deletions git/objects/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ class IndexObject(Object):
SubModule objects"""
__slots__ = ("path", "mode")

# for compatability with iterable lists
# for compatibility with iterable lists
_id_attribute_ = 'path'

def __init__(self, repo, binsha, mode=None, path=None):
Expand All @@ -137,7 +137,7 @@ def __init__(self, repo, binsha, mode=None, path=None):
:param binsha: 20 byte sha1
:param mode:
is the stat compatible file mode as int, use the stat module
to evaluate the infomration
to evaluate the information
:param path:
is the path to the file in the file system, relative to the git repository root, i.e.
file.ext or folder/other.ext
Expand Down Expand Up @@ -165,7 +165,7 @@ def _set_cache_(self, attr):
% (attr, type(self).__name__))
else:
super(IndexObject, self)._set_cache_(attr)
# END hanlde slot attribute
# END handle slot attribute

@property
def name(self):
Expand Down
4 changes: 2 additions & 2 deletions git/objects/commit.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ def count(self, paths='', **kwargs):
"""Count the number of commits reachable from this commit

:param paths:
is an optinal path or a list of paths restricting the return value
is an optional path or a list of paths restricting the return value
to commits actually containing the paths

:param kwargs:
Expand Down Expand Up @@ -192,7 +192,7 @@ def iter_items(cls, repo, rev, paths='', **kwargs):
:param repo: is the Repo
:param rev: revision specifier, see git-rev-parse for viable options
:param paths:
is an optinal path or list of paths, if set only Commits that include the path
is an optional path or list of paths, if set only Commits that include the path
or paths will be considered
:param kwargs:
optional keyword arguments to git rev-list where
Expand Down
Loading