Fix the documentation on getting an artifact's parent

cbarrete · Jul 23, 2024 · 84dde4e · 84dde4e
1 parent ef7fc2c
commit 84dde4e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/app/buck2_build_api/src/interpreter/rule_defs/artifact/methods.rs b/app/buck2_build_api/src/interpreter/rule_defs/artifact/methods.rs
@@ -66,7 +66,7 @@ pub enum EitherStarlarkArtifact {
 /// A single input or output file for an action.
 ///
 /// There is no `.parent` method on `artifact`, but in most cases
-/// `cmd_args(my_artifact).parent()` can be used to similar effect.
+/// `cmd_args(my_artifact, parent = 1)` can be used to similar effect.
 #[starlark_module]
 pub(crate) fn artifact_methods(builder: &mut MethodsBuilder) {
     /// The base name of this artifact. e.g. for an artifact at `foo/bar`, this is `bar`

diff --git a/app/buck2_build_api/src/interpreter/rule_defs/cmd_args/typ.rs b/app/buck2_build_api/src/interpreter/rule_defs/cmd_args/typ.rs
@@ -748,7 +748,7 @@ pub fn register_cmd_args(builder: &mut GlobalsBuilder) {
     /// * `ignore_artifacts` - if `True`, artifacts paths are used, but artifacts are not pulled.
     /// * `hidden` - artifacts not present on the command line, but added as dependencies.
     /// * `absolute_prefix` and `absolute_suffix` - added to the start and end of each artifact.
-    /// * `parent` - for all the artifacts use their parent directory.
+    /// * `parent` - for all the artifacts use their `parent`th directory (e.g. `parent = 1` for the directory the artifact is located, `parent = 2` for that directory's parent, etc.).
     /// * `relative_to` - make all artifact paths relative to a given location.
     /// * `replace_regex` - replaces arguments with a regular expression.
     ///