From 5f813276d91289833df019182c75d8eec9b1c276 Mon Sep 17 00:00:00 2001 From: Brian Gianforcaro Date: Mon, 14 Oct 2024 11:12:05 -0700 Subject: [PATCH] docs: Fix a variety of typos and spelling errors --- README.md | 14 +++++++------- WORKSPACE | 2 +- docs/new_conda_package_http_repository.md | 2 +- rules/conda_environment.bzl | 4 ++-- rules/new_conda_package_git_repository.bzl | 6 +++--- .../private/new_conda_package_repository_utils.bzl | 2 +- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ac4fc7a..71672ca 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ conda_package_lock( ) ``` -See the [documentaion][`conda_package_lock`] for that rule +See the [documentation][`conda_package_lock`] for that rule for additional options you might want to set for it. `bazel run` that target to generate the `conda_env.bzl` file, and then add @@ -201,7 +201,7 @@ You can add glob patterns like that for files or directories into the in which case those files will be skipped. If you wish, you can also use `exclude` to get rid of unnecessary content like -man pages or test suites, which might otherwise unnecssarily bloat your build. +man pages or test suites, which might otherwise unnecessarily bloat your build. ### Patches @@ -262,7 +262,7 @@ They've worked very well for us, and we don't forsee making major changes any time soon. So, yes (though this should not be construed as contradicting the license terms -which make clear that we provide no warantee). +which make clear that we provide no warranty). [^2]: The main differences between this public version of the rules and the internal version are due to divergence between our internal fork of @@ -332,7 +332,7 @@ Most of the time you only need to interact with `@conda_env`. On the roadmap. -There's nothing fundemental preventing it, +There's nothing fundamental preventing it, but it hasn't been a priority for us to work on it. Parts of it, such as work on other platforms, including `conda_package_lock`, @@ -342,7 +342,7 @@ due to a few hard-coded assumptions here and there. Unfortunately, cross compilation doesn't really work at the moment due to (ironically) the need to support `noarch` packages. -We need to be able to exectue the python executable in order to ask it +We need to be able to execute the python executable in order to ask it the correct path for `lib/pythonX.Y` to prepend for those packages. We could avoid this if we were willing to just assume that the answer is always `lib/pythonX.Y` where `X.Y` is always the major/minor version number, @@ -355,7 +355,7 @@ First of all, conda is not exclusively a Python ecosystem. Some aspects of putting together an environment are simply too complicated to do purely in starlark. -`go` has several desireable properties for performing those steps: +`go` has several desirable properties for performing those steps: - Go is more portable than python. No, really. For repository rules, you can't use a build target, so you're basically stuck using the system @@ -374,7 +374,7 @@ to do purely in starlark. to generate the BUILD files is going to be far less than the it saves by running a compiled executable rather than an interpreted script. - The canonical tool for formatting BUILD files, `buildifier`, is written in go. - The libraries backing it can be used to generate build files programatically. + The libraries backing it can be used to generate build files programmatically. - The bazel rules for go are very mature. The SDK repository rule knows how to use the host go, or download the SDK from the internet, diff --git a/WORKSPACE b/WORKSPACE index 122e322..5a502a9 100644 --- a/WORKSPACE +++ b/WORKSPACE @@ -19,7 +19,7 @@ conda_environment() ##################################################################### # Dependencies below here are only needed when developing within this -# repo, not required for using the rules. Specifially, they're +# repo, not required for using the rules. Specifically, they're # required for building the documentation. ##################################################################### diff --git a/docs/new_conda_package_http_repository.md b/docs/new_conda_package_http_repository.md index f74f2ae..ea1645c 100644 --- a/docs/new_conda_package_http_repository.md +++ b/docs/new_conda_package_http_repository.md @@ -36,7 +36,7 @@ See the documentation for the `conda_files` rule to determine which attribute to use for each file. There must be a `conda_manifest` target named `conda_metadata`, which must -include `index = "info/index.json"` (which is genereated by the repo rule). +include `index = "info/index.json"` (which is generated by the repo rule). There must be a `conda_deps` target named `conda_deps`, which should declare the targets which this package depends on. diff --git a/rules/conda_environment.bzl b/rules/conda_environment.bzl index b0f6ff7..c883822 100644 --- a/rules/conda_environment.bzl +++ b/rules/conda_environment.bzl @@ -141,7 +141,7 @@ def _generate_build_content( fail("multiple packages named " + pkg, attr = "conda_packages") if pkg == name: fail( - "package name must not match repostiory name " + pkg, + "package name must not match repository name " + pkg, attr = "conda_packages", ) auto_alias = _default_alias(pkg) @@ -159,7 +159,7 @@ def _generate_build_content( for alias, actual in aliases.items(): if alias == name: fail( - "alias must not match repostiory name " + pkg, + "alias must not match repository name " + pkg, attr = "conda_packages", ) if alias in all_packages: diff --git a/rules/new_conda_package_git_repository.bzl b/rules/new_conda_package_git_repository.bzl index 0ab7f88..f15346f 100644 --- a/rules/new_conda_package_git_repository.bzl +++ b/rules/new_conda_package_git_repository.bzl @@ -217,17 +217,17 @@ _new_conda_package_git_repository_attrs = { "The default is the repository name.", ), "exported_files": attr.string_list( - doc = "Does nothing. Retained for backwards compability.", + doc = "Does nothing. Retained for backwards compatibility.", ), "version": attr.string( doc = "The version of the package to report in the `index.json`. " + "This is completely optional and does not affect SBOM metadata " + - "computed by bazel. It is retained for backwards compatiblity.", + "computed by bazel. It is retained for backwards compatibility.", ), "license": attr.string( doc = "The package license to report in the `index.json`. " + "This is completely optional and does not affect SBOM metadata " + - "computed by bazel. It is retained for backwards compatiblity.", + "computed by bazel. It is retained for backwards compatibility.", ), } diff --git a/rules/private/new_conda_package_repository_utils.bzl b/rules/private/new_conda_package_repository_utils.bzl index dbd1ecb..5638e02 100644 --- a/rules/private/new_conda_package_repository_utils.bzl +++ b/rules/private/new_conda_package_repository_utils.bzl @@ -56,7 +56,7 @@ See the documentation for the `conda_files` rule to determine which attribute to use for each file. There must be a `conda_manifest` target named `conda_metadata`, which must -include `index = "info/index.json"` (which is genereated by the repo rule). +include `index = "info/index.json"` (which is generated by the repo rule). There must be a `conda_deps` target named `conda_deps`, which should declare the targets which this package depends on.