Merge pull request #1543 from Saran-pariyar/Saran-pariyar_branch

Author: rosahbruno

ARCHITECTURE.md

@@ -1,6 +1,6 @@
 # Architecture
 
-This document aims to give a high level overview of the
+This document aims to give a high-level overview of the
 Glean JavaScript SDK (aka Glean.js) architecture.
 
 This is a great place to start for newcomers to the project.
@@ -11,8 +11,7 @@ the [Glean.js developer documentation](docs/README.md).
 ## Context
 
 The Glean JavaScript SDK is part of [the Glean project](https://docs.telemetry.mozilla.org/concepts/glean/glean.html).
-An end-to-end data collection platform developed by Mozilla and primarily targeting Mozilla products
-across multiple platforms.
+An end-to-end data collection platform developed by Mozilla and primarily targeting Mozilla products across multiple platforms.
 
 Glean provides multiple client SDKs for different programming languages and platforms.
 One of the aspects that guide Glean SDK development is cross-platform consistency and the Glean
@@ -30,8 +29,8 @@ Firefox Desktop SDK in the [mozilla-central](https://hg.mozilla.org/mozilla-cent
 On a very high level a Glean SDK is a library which exposes APIs for users to record
 structured data and submit that data in an (again) structured format to a specific endpoint.
 
-Users cannot simply record arbitrary data though. The Glean SDKs expose specialized metrics APIs for
-different collection needs. The SDK is responsible to validating that the data given by a user is in
+Users cannot simply record arbitrary data, though. The Glean SDKs expose specialized metrics APIs for
+different collection needs. The SDK is responsible for validating that the data given by a user is in
 the correct format and only then recording it (or recording an error in case the data provided is
 not correct).
 
@@ -114,11 +113,9 @@ for all platforms, because each platform provides different APIs for these tasks
 for useless platform specific code not to bloat the size of the library on each platform,
 the `platform/` module contains implementations of identical interfaces in different platforms.
 
-This allows the pattern of only importing the necessary implementation of these modules on each
-platform. It also makes testing easier, because the exact same suite of tests can run for each of
-the platform specific implementation, thus guaranteeing that each modules works exactly the same
-in all platforms.
-
+This allows the pattern of only importing the necessary implementation of these modules on each platform.
+It also makes testing easier, because the exact same suite of tests can be run for each of the platform-specific implementations,
+ thus guaranteeing that each module works exactly the same on all platforms.
 ### `plugins/`
 
 The `plugins/` folder contains the Glean.js' plugins code.

automation/README.md

@@ -46,7 +46,7 @@ npm run size:report
 
 ### Docs
 
-Builds the Glean.js library for all the targeted platforms and document
+Builds the Glean.js library for all the targeted platforms and documents
 the size of the library and of each extra metric and plugin.
 
 To run the script without updating the documentation:
@@ -55,7 +55,7 @@ To run the script without updating the documentation:
 npm run size:docs:dry
 ```
 
-To run the script and update the documentation.
+To run the script and update the documentation:
 
 ```
 npm run size:docs

docs/guides/adding_a_new_metric_type.md

@@ -123,8 +123,8 @@ awaiting or callbacks.
 
 This is to say: any recording action must be wrapped in a `Glean.dispatcher.launch` block.
 
-Continuing on the String metric type example,
-let's look at how a simple string recording function will look like.
+Continuing with the String metric type example,
+let's look at what a simple string recording function will look like.
 
 ```ts
 function set(value: string): void {
@@ -227,7 +227,7 @@ a new release of Glean.js is made.
 
 ## Other
 
-Even after your are done with all the above steps, you still need to prepare other parts of the Glean
+Even after you are done with all the above steps, you still need to prepare other parts of the Glean
 ecosystem in order for you to be done implementing your new metric type.
 
 ### glean_parser

docs/guides/update_glean_parser.md

@@ -6,6 +6,6 @@ To update the version of glean_parser used by the Glean.js, run the `bin/update-
 bin/update-glean-parser-version.sh 1.28.3
 ```
 
-This will update the version in all the required places and create a commit with the changes. After that you just need to create a pull request with the changes.
+This will update the version in all the required places and create a commit with the changes. After that, you just need to create a pull request with the changes.
 
 No further action is required.

glean/src/cli.ts

@@ -15,11 +15,11 @@ import log, { LoggingLevel } from "./core/log.js";
 
 const LOG_TAG = "CLI";
 
-// The name of the directory which contains / will contain the Python virtual environment
+// The name of the directory which contains/will contain the Python virtual environment
 // used to run the glean-parser.
 //
 // > When a virtual environment is active, the VIRTUAL_ENV environment variable
-// > is set to the path of the virtual environment. This can be used to check if
+// > is set to the virtual environment's path. This can be used to check if
 // > one is running inside a virtual environment.
 //
 // See: https://docs.python.org/3/library/venv.html