From 0e600586aea596a488902ce90938b36ce7e9f6d5 Mon Sep 17 00:00:00 2001 From: Richard Levasseur Date: Wed, 16 Oct 2024 17:39:35 -0700 Subject: [PATCH] docs: add stubs so Bazel docs link to a valid file (#2309) The Bazel docs link to the implementation files, which were recently moved. To avoid users getting a 404, add stub files with some text to direct them somewhere useful. Work towards https://github.com/bazelbuild/bazel/issues/24014 --- python/private/common/py_binary_rule_bazel.bzl | 6 ++++++ python/private/common/py_library_rule_bazel.bzl | 6 ++++++ python/private/common/py_runtime_rule.bzl | 6 ++++++ python/private/common/py_test_rule_bazel.bzl | 6 ++++++ 4 files changed, 24 insertions(+) create mode 100644 python/private/common/py_binary_rule_bazel.bzl create mode 100644 python/private/common/py_library_rule_bazel.bzl create mode 100644 python/private/common/py_runtime_rule.bzl create mode 100644 python/private/common/py_test_rule_bazel.bzl diff --git a/python/private/common/py_binary_rule_bazel.bzl b/python/private/common/py_binary_rule_bazel.bzl new file mode 100644 index 0000000000..7858411963 --- /dev/null +++ b/python/private/common/py_binary_rule_bazel.bzl @@ -0,0 +1,6 @@ +"""Stub file for Bazel docs to link to. + +The Bazel docs link to this file, but the implementation was moved. + +Please see: https://rules-python.readthedocs.io/en/latest/api/rules_python/python/defs.html#py_binary +""" diff --git a/python/private/common/py_library_rule_bazel.bzl b/python/private/common/py_library_rule_bazel.bzl new file mode 100644 index 0000000000..be631c9087 --- /dev/null +++ b/python/private/common/py_library_rule_bazel.bzl @@ -0,0 +1,6 @@ +"""Stub file for Bazel docs to link to. + +The Bazel docs link to this file, but the implementation was moved. + +Please see: https://rules-python.readthedocs.io/en/latest/api/rules_python/python/defs.html#py_library +""" diff --git a/python/private/common/py_runtime_rule.bzl b/python/private/common/py_runtime_rule.bzl new file mode 100644 index 0000000000..cadb48c704 --- /dev/null +++ b/python/private/common/py_runtime_rule.bzl @@ -0,0 +1,6 @@ +"""Stub file for Bazel docs to link to. + +The Bazel docs link to this file, but the implementation was moved. + +Please see: https://rules-python.readthedocs.io/en/latest/api/rules_python/python/defs.html#py_runtime +""" diff --git a/python/private/common/py_test_rule_bazel.bzl b/python/private/common/py_test_rule_bazel.bzl new file mode 100644 index 0000000000..c89e3a65c4 --- /dev/null +++ b/python/private/common/py_test_rule_bazel.bzl @@ -0,0 +1,6 @@ +"""Stub file for Bazel docs to link to. + +The Bazel docs link to this file, but the implementation was moved. + +Please see: https://rules-python.readthedocs.io/en/latest/api/rules_python/python/defs.html#py_test +"""