From 25c4e4cd5d8314f393837faf3f0c27d1496eb38a Mon Sep 17 00:00:00 2001 From: Marc Wrobel Date: Mon, 29 Aug 2022 22:17:17 +0200 Subject: [PATCH] docs: fix minor typos in various documentations (#47290) (#47290) PR Close #47290 PR Close #47290 --- docs/BAZEL.md | 2 +- docs/CODING_STANDARDS.md | 2 +- docs/DEVELOPER.md | 4 ++-- docs/PUBLIC_API.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/BAZEL.md b/docs/BAZEL.md index 2f98a1573b8..6b0f887f9a6 100644 --- a/docs/BAZEL.md +++ b/docs/BAZEL.md @@ -239,7 +239,7 @@ yarn bazel analyze-profile filename_name.profile --html --html_details --html_hi This will generate a `filename_name.profile.html` file that you can open in your browser. -In the upper right corner that is a small table of contents with links to three areas: Tasks, Legend and Statistics. +In the upper right corner that is a small table of contents with links to three areas: Tasks, Legend, and Statistics. In the Tasks section you will find a graph of where time is spent. Legend shows what the colors in the Tasks graph mean. Hovering over the background will show what phase that is, while hovering over bars will show more details about that specific action. diff --git a/docs/CODING_STANDARDS.md b/docs/CODING_STANDARDS.md index 7d9030cd9b8..24c5203008b 100644 --- a/docs/CODING_STANDARDS.md +++ b/docs/CODING_STANDARDS.md @@ -82,7 +82,7 @@ Avoid `any` where possible. If you find yourself using `any`, consider whether a #### Getters and Setters -Getters and setters introduce openings for side-effects, add more complexity for code readers, +Getters and setters introduce openings for side effects, add more complexity for code readers, and generate additional code when targeting older browsers. * Only use getters and setters for `@Input` properties or when otherwise required for API diff --git a/docs/DEVELOPER.md b/docs/DEVELOPER.md index 3b850ab3af2..84c9c85a3b3 100644 --- a/docs/DEVELOPER.md +++ b/docs/DEVELOPER.md @@ -146,8 +146,8 @@ $ yarn lint ## Publishing Snapshot Builds When a build of any branch on the upstream fork angular/angular is green on CircleCI, it -automatically publishes build artifacts to repositories in the Angular org, for example, the `@angular/core` -package is published to https://github.com/angular/core-builds. +automatically publishes build artifacts to repositories in the Angular org. For example, +the `@angular/core` package is published to https://github.com/angular/core-builds. You may find that your un-merged change needs some validation from external participants. Rather than requiring them to pull your Pull Request and build Angular locally, they can depend on diff --git a/docs/PUBLIC_API.md b/docs/PUBLIC_API.md index 52fb194d0a6..e2d7328e820 100644 --- a/docs/PUBLIC_API.md +++ b/docs/PUBLIC_API.md @@ -15,7 +15,7 @@ Our semver, timed-release cycle and deprecation policy currently applies to thes - `@angular/service-worker` -One intentional omission from this list is `@angular/compiler`, which is currently considered a low level api and is subject to internal changes. These changes will not affect any applications or libraries using the higher-level apis (the command line interface or JIT compilation via `@angular/platform-browser-dynamic`). Only very specific use-cases require direct access to the compiler API (mostly tooling integration for IDEs, linters, etc). If you are working on this kind of integration, please reach out to us first. +One intentional omission from this list is `@angular/compiler`, which is currently considered a low level API and is subject to internal changes. These changes will not affect any applications or libraries using the higher-level APIs (the command line interface or JIT compilation via `@angular/platform-browser-dynamic`). Only very specific use-cases, such as tooling integration for IDEs and linters, require direct access to the compiler API. If you are working on this kind of integration, please reach out to us first. Package `@angular/bazel` is currently an Angular Labs project and not covered by the public API guarantees.