Skip to content

Commit a43fccf

Browse files
committed
docs: update and export information about mv
1 parent c221aa0 commit a43fccf

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

docs/cli.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ Renku Command Line
7676

7777
.. automodule:: renku.cli.rerun
7878

79+
.. _cli-mv:
80+
81+
``renku mv``
82+
------------
83+
84+
.. automodule:: renku.cli.move
85+
7986
.. _cli-workflow:
8087

8188
``renku workflow``

renku/cli/move.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,13 @@
1515
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1616
# See the License for the specific language governing permissions and
1717
# limitations under the License.
18-
"""Move a file in the repository."""
18+
"""Move or rename a file, a directory, or a symlink.
19+
20+
Moving a files that belongs to a dataset will update its metadata. It also
21+
will attempt to update tracking information for files stored in an external
22+
storage (using Git LFS). Finally it makes sure that all relative symlinks work
23+
after the move.
24+
"""
1925

2026
import os
2127
from subprocess import run
@@ -34,7 +40,7 @@
3440
@pass_local_client(clean=True, commit=True)
3541
@click.pass_context
3642
def move(ctx, client, sources, destination):
37-
"""Check your system and repository for potential problems."""
43+
"""Move files and check repository for potential problems."""
3844
import yaml
3945

4046
from renku.api._git import _expand_directories

0 commit comments

Comments
 (0)