replace javadoc docs with standard python style
We don't use javadoc in this project, so clean up the few places
that slipped in with the gitc code.
Change-Id: Ia365fb2d1e3188ad16b2f65b1a3b7e8466001946
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/291262
Reviewed-by: Michael Mortensen <mmortensen@google.com>
Tested-by: Mike Frysinger <vapier@google.com>
diff --git a/gitc_utils.py b/gitc_utils.py
index 11284e2..8ff7699 100644
--- a/gitc_utils.py
+++ b/gitc_utils.py
@@ -45,7 +45,8 @@
should not be overly large. Recommend calling this function multiple times
with each call not exceeding NUM_BATCH_RETRIEVE_REVISIONID projects.
- @param projects: List of project objects to set the revionExpr for.
+ Args:
+ projects: List of project objects to set the revionExpr for.
"""
# Retrieve the commit id for each project based off of it's current
# revisionExpr and it is not already a commit id.
@@ -73,7 +74,8 @@
This is the same logic used by Command.GetProjects(), which is used during
repo sync
- @param manifest: The XmlManifest object
+ Args:
+ manifest: The XmlManifest object
"""
mp = manifest.manifestProject
groups = mp.config.GetString('manifest.groups')
@@ -85,9 +87,10 @@
def generate_gitc_manifest(gitc_manifest, manifest, paths=None):
"""Generate a manifest for shafsd to use for this GITC client.
- @param gitc_manifest: Current gitc manifest, or None if there isn't one yet.
- @param manifest: A GitcManifest object loaded with the current repo manifest.
- @param paths: List of project paths we want to update.
+ Args:
+ gitc_manifest: Current gitc manifest, or None if there isn't one yet.
+ manifest: A GitcManifest object loaded with the current repo manifest.
+ paths: List of project paths we want to update.
"""
print('Generating GITC Manifest by fetching revision SHAs for each '
@@ -149,8 +152,9 @@
def save_manifest(manifest, client_dir=None):
"""Save the manifest file in the client_dir.
- @param client_dir: Client directory to save the manifest in.
- @param manifest: Manifest object to save.
+ Args:
+ manifest: Manifest object to save.
+ client_dir: Client directory to save the manifest in.
"""
if not client_dir:
client_dir = manifest.gitc_client_dir
diff --git a/repo b/repo
index b13e34c..f1b15c5 100755
--- a/repo
+++ b/repo
@@ -439,9 +439,11 @@
def gitc_parse_clientdir(gitc_fs_path):
"""Parse a path in the GITC FS and return its client name.
- @param gitc_fs_path: A subdirectory path within the GITC_FS_ROOT_DIR.
+ Args:
+ gitc_fs_path: A subdirectory path within the GITC_FS_ROOT_DIR.
- @returns: The GITC client name
+ Returns:
+ The GITC client name.
"""
if gitc_fs_path == GITC_FS_ROOT_DIR:
return None
