From 0154a528c77f69973779b86a11d7976099d3ce25 Mon Sep 17 00:00:00 2001 From: Richard Levasseur Date: Fri, 10 Jan 2025 17:13:57 -0800 Subject: [PATCH] docs: note direct_pyi_files/transitive_pyi_files are usually build-time only The pyi_srcs and pyi_deps attributes have this disclaimer already. The provider should, too, so behavior is better specified. --- python/private/py_info.bzl | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/python/private/py_info.bzl b/python/private/py_info.bzl index 2a02685362..ef654c303e 100644 --- a/python/private/py_info.bzl +++ b/python/private/py_info.bzl @@ -112,6 +112,9 @@ Type definition files (usually `.pyi` files) for the Python modules provided by this target. Usually they describe the source files listed in `direct_original_sources`. This field is primarily for static analysis tools. +These files are _usually_ build-time only and not included as part of a runnable +program. + :::{note} This may contain implementation-specific file types specific to a particular type checker. @@ -190,6 +193,9 @@ Python modules for this target and its transitive dependencies. this target. Usually they describe the source files listed in `transitive_original_sources`. This field is primarily for static analysis tools. +These files are _usually_ build-time only and not included as part of a runnable +program. + :::{note} This may contain implementation-specific file types specific to a particular type checker.