Skip to content

Commit da43a47

Browse files
authored
Fix doc typos
1 parent 8f76463 commit da43a47

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

git/repo/base.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -485,15 +485,15 @@ def tree(self, rev=None):
485485
def iter_commits(self, rev=None, paths='', **kwargs):
486486
"""A list of Commit objects representing the history of a given ref/commit
487487
488-
:parm rev:
488+
:param rev:
489489
revision specifier, see git-rev-parse for viable options.
490490
If None, the active branch will be used.
491491
492-
:parm paths:
492+
:param paths:
493493
is an optional path or a list of paths to limit the returned commits to
494494
Commits that do not contain that path or the paths will not be returned.
495495
496-
:parm kwargs:
496+
:param kwargs:
497497
Arguments to be passed to git-rev-list - common ones are
498498
max_count and skip
499499
@@ -585,7 +585,7 @@ def _get_alternates(self):
585585
def _set_alternates(self, alts):
586586
"""Sets the alternates
587587
588-
:parm alts:
588+
:param alts:
589589
is the array of string paths representing the alternates at which
590590
git should look for objects, i.e. /home/user/repo/.git/objects
591591
@@ -695,7 +695,7 @@ def blame_incremental(self, rev, file, **kwargs):
695695
Unlike .blame(), this does not return the actual file's contents, only
696696
a stream of BlameEntry tuples.
697697
698-
:parm rev: revision specifier, see git-rev-parse for viable options.
698+
:param rev: revision specifier, see git-rev-parse for viable options.
699699
:return: lazy iterator of BlameEntry tuples, where the commit
700700
indicates the commit to blame for the line, and range
701701
indicates a span of line numbers in the resulting file.
@@ -757,7 +757,7 @@ def blame_incremental(self, rev, file, **kwargs):
757757
def blame(self, rev, file, incremental=False, **kwargs):
758758
"""The blame information for the given file at the given revision.
759759
760-
:parm rev: revision specifier, see git-rev-parse for viable options.
760+
:param rev: revision specifier, see git-rev-parse for viable options.
761761
:return:
762762
list: [git.Commit, list: [<line>]]
763763
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
871871
or None in which case the repository will be created in the current
872872
working directory
873873
874-
:parm mkdir:
874+
:param mkdir:
875875
if specified will create the repository directory if it doesn't
876876
already exists. Creates the directory with a mode=0755.
877877
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
886886
can lead to information disclosure, allowing attackers to
887887
access the contents of environment variables
888888
889-
:parm kwargs:
889+
:param kwargs:
890890
keyword arguments serving as additional options to the git-init command
891891
892892
:return: ``git.Repo`` (the newly created repo)"""
@@ -984,10 +984,10 @@ def clone_from(cls, url, to_path, progress=None, env=None, **kwargs):
984984
def archive(self, ostream, treeish=None, prefix=None, **kwargs):
985985
"""Archive the tree at the given revision.
986986
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
991991
992992
* Use the 'format' argument to define the kind of format. Use
993993
specialized ostreams to write any format supported by python.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy