diff options
Diffstat (limited to 'git')
| -rw-r--r-- | git/index/base.py | 8 | ||||
| -rw-r--r-- | git/objects/submodule/base.py | 2 | ||||
| -rw-r--r-- | git/remote.py | 4 | ||||
| -rw-r--r-- | git/repo/base.py | 6 | ||||
| -rw-r--r-- | git/util.py | 5 |
5 files changed, 12 insertions, 13 deletions
diff --git a/git/index/base.py b/git/index/base.py index 02299275..62ac9389 100644 --- a/git/index/base.py +++ b/git/index/base.py @@ -219,7 +219,7 @@ class IndexFile(LazyMixin, diff.Diffable, Serializable): """Merge the given rhs treeish into the current index, possibly taking a common base treeish into account. - As opposed to the from_tree_ method, this allows you to use an already + As opposed to the :func:`IndexFile.from_tree` method, this allows you to use an already existing tree as the left side of the merge :param rhs: @@ -830,7 +830,7 @@ class IndexFile(LazyMixin, diff.Diffable, Serializable): to a path relative to the git repository directory containing the working tree - The path string may include globs, such as *.c. + The path string may include globs, such as \\*.c. - Blob Object Only the path portion is used in this case. @@ -998,7 +998,7 @@ class IndexFile(LazyMixin, diff.Diffable, Serializable): If False, these will trigger a CheckoutError. :param fprogress: - see Index.add_ for signature and explanation. + see :func:`IndexFile.add` for signature and explanation. The provided progress information will contain None as path and item if no explicit paths are given. Otherwise progress information will be send prior and after a file has been checked out @@ -1010,7 +1010,7 @@ class IndexFile(LazyMixin, diff.Diffable, Serializable): iterable yielding paths to files which have been checked out and are guaranteed to match the version stored in the index - :raise CheckoutError: + :raise exc.CheckoutError: If at least one file failed to be checked out. This is a summary, hence it will checkout as many files as it can anyway. If one of files or directories do not exist in the index diff --git a/git/objects/submodule/base.py b/git/objects/submodule/base.py index 722d341c..ef8dd1a9 100644 --- a/git/objects/submodule/base.py +++ b/git/objects/submodule/base.py @@ -965,7 +965,7 @@ class Submodule(IndexObject, Iterable, Traversable): @unbare_repo def config_writer(self, index=None, write=True): """:return: a config writer instance allowing you to read and write the data - belonging to this submodule into the .gitmodules file. + belonging to this submodule into the .gitmodules file. :param index: if not None, an IndexFile instance which should be written. defaults to the index of the Submodule's parent repository. diff --git a/git/remote.py b/git/remote.py index 37c0ccd3..06e9d3b7 100644 --- a/git/remote.py +++ b/git/remote.py @@ -827,10 +827,8 @@ class Remote(LazyMixin, Iterable): * None to discard progress information * A function (callable) that is called with the progress information. - Signature: ``progress(op_code, cur_count, max_count=None, message='')``. - - `Click here <http://goo.gl/NPa7st>`_ for a description of all arguments + `Click here <http://goo.gl/NPa7st>`__ for a description of all arguments given to the function. * An instance of a class derived from ``git.RemoteProgress`` that overrides the ``update()`` function. diff --git a/git/repo/base.py b/git/repo/base.py index a7ca5ec6..591ccec5 100644 --- a/git/repo/base.py +++ b/git/repo/base.py @@ -270,9 +270,9 @@ class Repo(object): @property def common_dir(self): - """:return: The git dir that holds everything except possibly HEAD, - FETCH_HEAD, ORIG_HEAD, COMMIT_EDITMSG, index, and logs/ . """ + :return: The git dir that holds everything except possibly HEAD, + FETCH_HEAD, ORIG_HEAD, COMMIT_EDITMSG, index, and logs/.""" return self._common_dir or self.git_dir @property @@ -988,7 +988,7 @@ class Repo(object): :param multi_options: A list of Clone options that can be provided multiple times. One option per list item which is passed exactly as specified to clone. For example ['--config core.filemode=false', '--config core.ignorecase', - '--recurse-submodule=repo1_path', '--recurse-submodule=repo2_path'] + '--recurse-submodule=repo1_path', '--recurse-submodule=repo2_path'] :param kwargs: * odbt = ObjectDatabase Type, allowing to determine the object database implementation used by the returned Repo instance diff --git a/git/util.py b/git/util.py index d8671107..216703cb 100644 --- a/git/util.py +++ b/git/util.py @@ -39,11 +39,11 @@ from .exc import InvalidGitRepositoryError # Handle once test-cases are back up and running. # Most of these are unused here, but are for use by git-python modules so these # don't see gitdb all the time. Flake of course doesn't like it. -__all__ = ("stream_copy", "join_path", "to_native_path_windows", "to_native_path_linux", +__all__ = ["stream_copy", "join_path", "to_native_path_linux", "join_path_native", "Stats", "IndexFileSHA1Writer", "Iterable", "IterableList", "BlockingLockFile", "LockFile", 'Actor', 'get_user_id', 'assure_directory_exists', 'RemoteProgress', 'CallableRemoteProgress', 'rmtree', 'unbare_repo', - 'HIDE_WINDOWS_KNOWN_ERRORS') + 'HIDE_WINDOWS_KNOWN_ERRORS'] log = logging.getLogger(__name__) @@ -148,6 +148,7 @@ if is_win: def to_native_path_linux(path): return path.replace('\\', '/') + __all__.append("to_native_path_windows") to_native_path = to_native_path_windows else: # no need for any work on linux |