Finish addressing the comments

aignas · aignas · commit ccd5ce02efb8 · 2023-08-03T18:35:08.000+09:00
diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -1,5 +1,16 @@
 # For Developers
 
+## Updating internal dependencies
+
+1. Modify the `./python/pip_install/tools/requirements.txt` file and run:
+   ```
+   bazel run //tools/private/update_deps:update_pip_deps
+   ```
+1. Bump the coverage dependencies using the script using:
+   ```
+   bazel run //tools/private/update_deps:update_coverage_deps <VERSION>
+   ```
+
 ## Releasing
 
 Start from a clean checkout at `main`.
@@ -8,16 +19,6 @@ Before running through the release it's good to run the build and the tests loca
 also test-drive the commit in an existing Bazel workspace to sanity check functionality.
 
 #### Steps
-1. (Optional) modify the `./python/pip_install/tools/requirements.txt` file and run `./tools/update_pip_deps.sh` script:
-   1. Using system python:
-   ```bash
-   ./tools/update_pip_deps.py
-   ```
-   1. Using bazel toolchain:
-   ```bash
-   bazel run --enable_bzlmod @python_3_10_9//:python3 -- ./tools/update_pip_deps.py
-   ```
-1. (Optional) bump the coverage dependencies using the script `./tools/update_coverage_deps.py <VERSION>`.
 1. [Determine the next semantic version number](#determining-semantic-version)
 1. Create a tag and push, e.g. `git tag 0.5.0 upstream/main && git push upstream --tags`
    NOTE: Pushing the tag will trigger release automation.
diff --git a/tools/private/update_deps/update_file.py b/tools/private/update_deps/update_file.py
@@ -45,7 +45,7 @@ def replace_snippet(
     start_marker: str,
     end_marker: str,
 ) -> str:
-    """update a file on disk to replace text in a file between two markers.
+    """Update a file on disk to replace text in a file between two markers.
 
     Args:
         path: pathlib.Path, the path to the file to be modified.
diff --git a/tools/private/update_deps/update_file_test.py b/tools/private/update_deps/update_file_test.py
@@ -14,7 +14,7 @@
 
 import unittest
 
-from tools.private.update_file import replace_snippet, unified_diff
+from tools.private.update_deps.update_file import replace_snippet, unified_diff
 
 
 class TestReplaceSnippet(unittest.TestCase):
