Skip to content

Commit f5ab6f8

Browse files
committed
Adapt documentation according to previous commit
1 parent eaafb5b commit f5ab6f8

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

github2pandas/version.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ class Version():
4343
-------
4444
handleError(func, path, exc_info)
4545
Error handler function which will try to change file permission and call the calling function again.
46-
clone_repository(repo, data_root_dir, github_token=None)
46+
clone_repository(repo, data_root_dir, github_token=None, new_clone=False):
4747
Cloning repository from git.
4848
generate_data_base(data_root_dir)
4949
Extracting version data from a local repository and storing them in a mysql data base.
50-
generate_version_pandas_tables(repo, data_root_dir)
50+
generate_version_pandas_tables(repo, data_root_dir, check_for_updates=True)
5151
Extracting edits and commits in a pandas table.
5252
define_unknown_users(user_list, data_root_dir)
5353
Define unknown users in commits pandas table.
@@ -114,7 +114,7 @@ def clone_repository(repo, data_root_dir, github_token=None, new_clone=False):
114114
Repo dir of the project.
115115
github_token : str
116116
Token string.
117-
new_clone : bool
117+
new_clone : bool, default=True
118118
Initiating a completely new clone of the repository
119119
120120
Notes
@@ -219,6 +219,8 @@ def generate_version_pandas_tables(repo, data_root_dir, check_for_updates=True):
219219
Repository object from pygithub.
220220
data_root_dir: str
221221
Data root directory for the repository.
222+
check_for_updates : bool, default=True
223+
Check first if there are any new pull requests information.
222224
223225
"""
224226

0 commit comments

Comments
 (0)