Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed typos: normla -> normal #1699

Merged
merged 1 commit into from
Dec 14, 2022
Merged

Conversation

sulmone
Copy link
Contributor

@sulmone sulmone commented Dec 13, 2022

No description provided.

@google-cla
Copy link

google-cla bot commented Dec 13, 2022

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@illicitonion
Copy link
Collaborator

Thanks so much for sending out this fix!

It looks like CI is currently failing because the file you've edited is actually generated, and the place it's generated from hasn't been updated. If you take a look in crate_universe/3rdparty/crates/defs.bzl you'll see a couple if places with the same typo - if you can fix those up, CI will go green (in general, the docs flow is to edit the .bzl files, then run docs/update_docs.sh which will do the re-generation, though for this particular change just editing both places works fine too :))

A quick grep showed me it looks like we've actually copied and pasted this buggy docstring into a bunch of places:

Click to expand
% rg normla   
crate_universe/src/rendering/templates/module_bzl.j2
156:        normal_dev (bool, optional): If True, normla dev dependencies will be
225:        normal_dev (bool, optional): If True, normla dev dependencies will be

bindgen/3rdparty/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

examples/crate_universe_unnamed/vendor_remote_pkgs/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

examples/crate_universe_unnamed/vendor_remote_manifests/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

examples/sys/basic/3rdparty/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

examples/crate_universe/vendor_local_manifests/crates/defs.bzl
154: normal_dev (bool, optional): If True, normla dev dependencies will be
223: normal_dev (bool, optional): If True, normla dev dependencies will be

examples/crate_universe/vendor_external/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

examples/sys/complex/3rdparty/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

examples/crate_universe/vendor_remote_manifests/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

examples/crate_universe/vendor_remote_pkgs/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

crate_universe/3rdparty/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

docs/crate_universe.md
424:| normal_dev | If True, normla dev dependencies will be included in the output list.. | False |
457:| normal_dev | If True, normla dev dependencies will be included in the output list.. | False |

examples/crate_universe/vendor_local_pkgs/crates/defs.bzl
154: normal_dev (bool, optional): If True, normla dev dependencies will be
223: normal_dev (bool, optional): If True, normla dev dependencies will be

tools/rust_analyzer/3rdparty/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

util/import/3rdparty/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

wasm_bindgen/3rdparty/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

proto/3rdparty/crates/defs.bzl
156: normal_dev (bool, optional): If True, normla dev dependencies will be
225: normal_dev (bool, optional): If True, normla dev dependencies will be

If you're up for fixing them all, that'd be wonderful, but not a problem if not, one fix is still better than 0!

Copy link
Collaborator

@illicitonion illicitonion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much!

@illicitonion illicitonion merged commit 40dee95 into bazelbuild:main Dec 14, 2022
@sulmone sulmone deleted the patch-1 branch December 14, 2022 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants