docs(project): add submodule docs

max-wittig · max-wittig · commit b5969a2dcea7 · 2019-10-06T18:10:40.000+02:00
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -151,6 +151,15 @@ Get the content and metadata of a file for a commit, using a blob sha::
     content = base64.b64decode(file_info['content'])
     size = file_info['size']
 
+Update a project submodule::
+
+    items = project.update_submodule(
+        submodule="foo/bar",
+        branch="master",
+        commit_sha="4c3674f66071e30b3311dac9b9ccc90502a72664",
+        commit_message="Message",  # optional
+    )
+
 Get the repository archive::
 
     tgz = project.repository_archive()
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -3888,7 +3888,7 @@ class Project(SaveMixin, ObjectDeleteMixin, RESTObject):
     @cli.register_custom_action("Project", ("submodule", "branch", "commit_sha"))
     @exc.on_http_error(exc.GitlabUpdateError)
     def update_submodule(self, submodule, branch, commit_sha, **kwargs):
-        """Transfer a project to the given namespace ID
+        """Update a project submodule
 
         Args:
             submodule (str): Full path to the submodule
