diff options
| author |  laurentlb <laurentlb@google.com> | 2017-12-14 03:41:55 -0800 |
|---|---|---|
| committer |  Copybara-Service <copybara-piper@google.com> | 2017-12-14 03:43:52 -0800 |
| commit | 749165f7b0991feecc8209671c559e97ff43dcab (patch) | |
| tree | 2a7e1924bf51aa5c9f00bbb6d1be010a82ad99b5 /site/docs/best-practices.md | |
| parent | 10c8018d73e7dbefbc4cc730e0201cda9d9326ba (diff) | |
Remove the word 'Skylark' when it doesn't add any value.
The word Skylark tends to be overused. We should use it only when we refer
to the language itself.
In many places, the word 'Skylark' was used, even if the reader may not know
it (e.g. "create a rule" is clearer than "create a Skylark rule").
RELNOTES: None.
PiperOrigin-RevId: 179024448
Diffstat (limited to 'site/docs/best-practices.md')
| -rw-r--r-- | site/docs/best-practices.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/site/docs/best-practices.md b/site/docs/best-practices.md index 9e16d9855b..531c7a8cac 100644 --- a/site/docs/best-practices.md +++ b/site/docs/best-practices.md @@ -40,7 +40,7 @@ This document uses the requirement levels described in - [WORKSPACE files](#workspace-files) - [Repository rules](#repository-rules) - [Custom BUILD files](#custom-build-files) - - [Skylark repository rules](#skylark-repository-rules) + - [Repository rules](#repository-rules) - [Programming languages](#programming-languages) - [C++ and Bazel](#c-and-bazel) - [Java and Bazel](#java-and-bazel) @@ -110,19 +110,19 @@ guide](https://docs.bazel.build/skylark/build-style.html). ## .bzl files style guide -See the [Style guide for .bzl -files](https://docs.bazel.build/skylark/bzl-style.html) for Skylark rule guidelines. +See the [Style guide for .bzl files](https://docs.bazel.build/skylark/bzl-style.html) +for guidelines. ## Packaging rules See [Packaging rules](https://docs.bazel.build/skylark/deploying.html) for advice -on how to structure and where to put new Skylark rules. +on how to structure and where to put new rules. ## Rule choice When using a language for which Bazel has built-in rules (e.g., C++), prefer using these rules to -writing your own in Skylark. These rules are documented in the [build -encyclopedia](https://docs.bazel.build/be/overview.html). +writing your own. These rules are documented in the +[build encyclopedia](https://docs.bazel.build/be/overview.html). # WORKSPACE files @@ -147,9 +147,9 @@ alternatives. When using a `new_` repository rule, prefer to specify `build_file_content`, not `build_file`. -## Skylark repository rules +## Repository rules -A Skylark repository rule should generally be responsible for: +A repository rule should generally be responsible for: - Detecting system settings and writing them to files. - Finding resources elsewhere on the system. |