Skip to content

Commit

Permalink
docs: fixing typos and grammatical errors in several documentation fi…
Browse files Browse the repository at this point in the history
…les (#47254)

- Fixes grammar issues in various markdown files, like the `DEBUG.md` or `DEVELOPER.md`

PR Close #47254
  • Loading branch information
vyom1611 authored and AndrewKushnir committed Sep 6, 2022
1 parent b8fd0da commit 0d13cc7
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/BAZEL.md
Expand Up @@ -10,7 +10,7 @@ Bazel.
## Installation

In order to ensure that everyone builds Angular in a _consistent_ way, Bazel
will be installed through NPM and therefore it's not necessary to install Bazel
will be installed through NPM. It's not necessary to install Bazel
manually.

The binaries for Bazel will be provided by the [`@bazel/bazelisk`](https://github.com/bazelbuild/bazelisk)
Expand Down Expand Up @@ -157,7 +157,7 @@ Of course, non-hermeticity in an action can cause problems.
At worst, you can fetch a broken artifact from the cache, making your build non-reproducible.
For this reason, we are careful to implement our Bazel rules to depend only on their inputs.

Currently we only use remote caching on CircleCI and we let Angular core developers enable remote caching to speed up their builds.
Currently, we only use remote caching on CircleCI. We let Angular core developers enable remote caching to speed up their builds.

### Remote cache in development

Expand Down Expand Up @@ -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.

On 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.
Expand Down
4 changes: 2 additions & 2 deletions docs/DEBUG.md
Expand Up @@ -6,7 +6,7 @@ The core packages are tested both in the browser (via Karma) and on the server (
## Debugging in Karma

It is useful to focus your debugging on one test at a time by changing that test to be
defined using the `fit(...)` function, rather than `it(...)`. Moreover it can be helpful
defined using the `fit(...)` function, rather than `it(...)`. Moreover, it can be helpful
to place a `debugger` statement in this `fit` clause to cause the debugger to stop when
it hits this test.

Expand All @@ -16,7 +16,7 @@ document.
## Debugging in Node

It is useful to focus your debugging on one test at a time by changing that test to be
defined using the `fit(...)` function, rather than `it(...)`. Moreover it can be helpful
defined using the `fit(...)` function, rather than `it(...)`. Moreover, it can be helpful
to place a `debugger` statement in this `fit` clause to cause the debugger to stop when
it hits this test.

Expand Down
2 changes: 1 addition & 1 deletion docs/DEBUG_COMPONENTS_REPO_IVY.md
@@ -1,6 +1,6 @@
# Debugging the `components-repo-unit-tests` job

Currently all changes to Ivy are validated against the test suite of the
Currently, all changes to Ivy are validated against the test suite of the
`angular/components` repository. In order to debug the `components-repo-unit-tests` CI
job, the following steps can be used:

Expand Down
4 changes: 2 additions & 2 deletions docs/DEVELOPER.md
Expand Up @@ -31,7 +31,7 @@ following products on your development machine:

* [Yarn](https://yarnpkg.com) (version specified in the engines field of [`package.json`](../package.json)) which is used to install dependencies.

* Optional: [Java](https://openjdk.java.net/) version 7 or higher as required by [Closure Compiler](https://developers.google.com/closure/compiler). Most developers will not need this. Java is required for running some of the integration tests.
* Optional: [Java](https://openjdk.java.net/) version 7 or higher than required by [Closure Compiler](https://developers.google.com/closure/compiler). Most developers will not need this. Java is required for running some integration tests.

## Getting the Sources

Expand Down Expand Up @@ -146,7 +146,7 @@ $ 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, eg. the `@angular/core`
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.
Expand Down
2 changes: 1 addition & 1 deletion docs/GITHUB_PROCESS.md
Expand Up @@ -53,7 +53,7 @@ decision.

## What if I want to implement the feature to help the Angular team?

Often implementing the feature as an separate package is a better option. Building an external
Often implementing the feature as a separate package is a better option. Building an external
package rather than including the functionality in Angular helps with:

- Keeping the framework's runtime smaller and simpler
Expand Down

0 comments on commit 0d13cc7

Please sign in to comment.