Skip to content

Commit

Permalink
docs: Fix a variety of typos and spelling errors
Browse files Browse the repository at this point in the history
  • Loading branch information
bgianfo committed Oct 14, 2024
1 parent e20ca46 commit 08dbc3f
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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`,
Expand All @@ -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,
Expand All @@ -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
Expand All @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#####################################################################

Expand Down
2 changes: 1 addition & 1 deletion docs/new_conda_package_http_repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions rules/conda_environment.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions rules/new_conda_package_git_repository.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
),
}

Expand Down
2 changes: 1 addition & 1 deletion rules/private/new_conda_package_repository_utils.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 08dbc3f

Please sign in to comment.