| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
2 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -485,15 +485,15 @@ def tree(self, rev=None): | |||
| 485 | 485 | def iter_commits(self, rev=None, paths='', **kwargs): | |
| 486 | 486 | """A list of Commit objects representing the history of a given ref/commit | |
| 487 | 487 | ||
| 488 | - :parm rev: | ||
| 488 | + :param rev: | ||
| 489 | 489 | revision specifier, see git-rev-parse for viable options. | |
| 490 | 490 | If None, the active branch will be used. | |
| 491 | 491 | ||
| 492 | - :parm paths: | ||
| 492 | + :param paths: | ||
| 493 | 493 | is an optional path or a list of paths to limit the returned commits to | |
| 494 | 494 | Commits that do not contain that path or the paths will not be returned. | |
| 495 | 495 | ||
| 496 | - :parm kwargs: | ||
| 496 | + :param kwargs: | ||
| 497 | 497 | Arguments to be passed to git-rev-list - common ones are | |
| 498 | 498 | max_count and skip | |
| 499 | 499 | ||
@@ -585,7 +585,7 @@ def _get_alternates(self): | |||
| 585 | 585 | def _set_alternates(self, alts): | |
| 586 | 586 | """Sets the alternates | |
| 587 | 587 | ||
| 588 | - :parm alts: | ||
| 588 | + :param alts: | ||
| 589 | 589 | is the array of string paths representing the alternates at which | |
| 590 | 590 | git should look for objects, i.e. /home/user/repo/.git/objects | |
| 591 | 591 | ||
@@ -695,7 +695,7 @@ def blame_incremental(self, rev, file, **kwargs): | |||
| 695 | 695 | Unlike .blame(), this does not return the actual file's contents, only | |
| 696 | 696 | a stream of BlameEntry tuples. | |
| 697 | 697 | ||
| 698 | - :parm rev: revision specifier, see git-rev-parse for viable options. | ||
| 698 | + :param rev: revision specifier, see git-rev-parse for viable options. | ||
| 699 | 699 | :return: lazy iterator of BlameEntry tuples, where the commit | |
| 700 | 700 | indicates the commit to blame for the line, and range | |
| 701 | 701 | indicates a span of line numbers in the resulting file. | |
@@ -757,7 +757,7 @@ def blame_incremental(self, rev, file, **kwargs): | |||
| 757 | 757 | def blame(self, rev, file, incremental=False, **kwargs): | |
| 758 | 758 | """The blame information for the given file at the given revision. | |
| 759 | 759 | ||
| 760 | - :parm rev: revision specifier, see git-rev-parse for viable options. | ||
| 760 | + :param rev: revision specifier, see git-rev-parse for viable options. | ||
| 761 | 761 | :return: | |
| 762 | 762 | list: [git.Commit, list: [<line>]] | |
| 763 | 763 | A list of tuples associating a Commit object with a list of lines that | |
@@ -871,7 +871,7 @@ def init(cls, path=None, mkdir=True, odbt=GitCmdObjectDB, expand_vars=True, **kw | |||
| 871 | 871 | or None in which case the repository will be created in the current | |
| 872 | 872 | working directory | |
| 873 | 873 | ||
| 874 | - :parm mkdir: | ||
| 874 | + :param mkdir: | ||
| 875 | 875 | if specified will create the repository directory if it doesn't | |
| 876 | 876 | already exists. Creates the directory with a mode=0755. | |
| 877 | 877 | Only effective if a path is explicitly given | |
@@ -886,7 +886,7 @@ def init(cls, path=None, mkdir=True, odbt=GitCmdObjectDB, expand_vars=True, **kw | |||
| 886 | 886 | can lead to information disclosure, allowing attackers to | |
| 887 | 887 | access the contents of environment variables | |
| 888 | 888 | ||
| 889 | - :parm kwargs: | ||
| 889 | + :param kwargs: | ||
| 890 | 890 | keyword arguments serving as additional options to the git-init command | |
| 891 | 891 | ||
| 892 | 892 | :return: ``git.Repo`` (the newly created repo)""" | |
@@ -984,10 +984,10 @@ def clone_from(cls, url, to_path, progress=None, env=None, **kwargs): | |||
| 984 | 984 | def archive(self, ostream, treeish=None, prefix=None, **kwargs): | |
| 985 | 985 | """Archive the tree at the given revision. | |
| 986 | 986 | ||
| 987 | - :parm ostream: file compatible stream object to which the archive will be written as bytes | ||
| 988 | - :parm treeish: is the treeish name/id, defaults to active branch | ||
| 989 | - :parm prefix: is the optional prefix to prepend to each filename in the archive | ||
| 990 | - :parm kwargs: Additional arguments passed to git-archive | ||
| 987 | + :param ostream: file compatible stream object to which the archive will be written as bytes | ||
| 988 | + :param treeish: is the treeish name/id, defaults to active branch | ||
| 989 | + :param prefix: is the optional prefix to prepend to each filename in the archive | ||
| 990 | + :param kwargs: Additional arguments passed to git-archive | ||
| 991 | 991 | ||
| 992 | 992 | * Use the 'format' argument to define the kind of format. Use | |
| 993 | 993 | specialized ostreams to write any format supported by python. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -802,11 +802,11 @@ class BlockingLockFile(LockFile): | |||
| 802 | 802 | def __init__(self, file_path, check_interval_s=0.3, max_block_time_s=MAXSIZE): | |
| 803 | 803 | """Configure the instance | |
| 804 | 804 | ||
| 805 | - :parm check_interval_s: | ||
| 805 | + :param check_interval_s: | ||
| 806 | 806 | Period of time to sleep until the lock is checked the next time. | |
| 807 | 807 | By default, it waits a nearly unlimited time | |
| 808 | 808 | ||
| 809 | - :parm max_block_time_s: Maximum amount of seconds we may lock""" | ||
| 809 | + :param max_block_time_s: Maximum amount of seconds we may lock""" | ||
| 810 | 810 | super(BlockingLockFile, self).__init__(file_path) | |
| 811 | 811 | self._check_interval = check_interval_s | |
| 812 | 812 | self._max_block_time = max_block_time_s | |
| Back | FazBrowse Home | New Git URL |
0 commit comments