chore: update docs

kczulko · Dec 1, 2024 · 848cfcf · 848cfcf
1 parent 9017f49
commit 848cfcf
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/docs/repo_rules.md b/docs/repo_rules.md
@@ -13,8 +13,9 @@ nimble_install(<a href="#nimble_install-name">name</a>, <a href="#nimble_install
 </pre>
 
 Runs `nimble install` on `nimble_file` attribute which brings dependencies into the scope.
-CAUTION: This "action" is not cached in repository cache by Bazel therefore it is suggested
-to generate `nimble.lock` file and then use `nimble_lock` rule which is also faster than `nimble_install`.
+CAUTION: Such a simple wrapper around `nimble` invocation comes with a cost of omitting Bazel's
+repository cache. Therefore it is suggested to generate `nimble.lock` file and then use `nimble_lock`
+repository rule (with the appropriate `nimble_lock_update` target). See `numericalnim` e2e example.
 
 **ATTRIBUTES**
 

diff --git a/nim/private/nimble/nimble_install.bzl b/nim/private/nimble/nimble_install.bzl
@@ -51,8 +51,9 @@ nimble_install = repository_rule(
     implementation = _nimble_install_impl,
     doc = """
     Runs `nimble install` on `nimble_file` attribute which brings dependencies into the scope.
-    CAUTION: This "action" is not cached in repository cache by Bazel therefore it is suggested
-    to generate `nimble.lock` file and then use `nimble_lock` rule which is also faster than `nimble_install`.
+    CAUTION: Such a simple wrapper around `nimble` invocation comes with a cost of omitting Bazel's
+    repository cache. Therefore it is suggested to generate `nimble.lock` file and then use `nimble_lock`
+    repository rule (with the appropriate `nimble_lock_update` target). See `numericalnim` e2e example.
     """
 )