[nspcc-dev#216] English Check

Signed-off-by: Elizaveta Chichindaeva <[email protected]>

CONTRIBUTING.md

@@ -44,8 +44,8 @@ $ git merge upstream/master
 ```
 
 ### Create your feature branch
-Before making code changes, make sure you create a separate branch for these
-changes. Maybe you will find it convenient to name branch in
+Before making code changes, make sure you have created a separate branch for these
+changes. Maybe you will find it convenient to name branch in the
 `<type>/<Issue>-<changes_topic>` format.
 
 ```sh
@@ -106,9 +106,9 @@ To sign your work, just add a line like this at the end of your commit message:
 Signed-off-by: Samii Sakisaka <[email protected]>
 ```
 
-This can easily be done with the `--signoff` option to `git commit`.
+This can be done easily with the `--signoff` option to `git commit`.
 
-By doing this you state that you can certify the following (from [The Developer
+By doing this, you state that you can certify the following (from [The Developer
 Certificate of Origin](https://developercertificate.org/)):
 
 ```

README.md

@@ -29,7 +29,7 @@ This repository contains:
 Feel free to contribute to this project after reading the [contributing
 guidelines](CONTRIBUTING.md).
 
-Before starting to work on a certain topic, create a new issue first,
+Before you start working on a certain topic, first create a new issue
 describing the feature/topic you are going to implement.
 
 ## License

accounting/service.proto

@@ -13,7 +13,7 @@ import "session/types.proto";
 // other NeoFS nodes to get information about the account balance. Deposit and
 // Withdraw operations can't be implemented here, as they require Mainnet NeoFS
 // smart contract invocation. Transfer operations between internal NeoFS
-// accounts are possible, if both use the same token type.
+// accounts are possible if both use the same token type.
 service AccountingService {
   // Returns the amount of funds in GAS token for the requested NeoFS account.
   //
@@ -26,7 +26,7 @@ service AccountingService {
 
 // BalanceRequest message
 message BalanceRequest {
-  // To indicate the account for which the balance is requested, it's identifier
+  // To indicate the account for which the balance is requested, its identifier
   // is used. It can be any existing account in NeoFS sidechain `Balance` smart
   // contract. If omitted, client implementation MUST set it to the request's
   // signer `OwnerID`.
@@ -51,7 +51,7 @@ message BalanceRequest {
 // BalanceResponse message
 message BalanceResponse {
   // The amount of funds in GAS token for the `OwnerID`'s account requested.
-  // Balance is `Decimal` format to avoid precision issues with rounding.
+  // Balance is given in the `Decimal` format to avoid precision issues with rounding.
   message Body {
     // Amount of funds in GAS token for the requested account.
     Decimal balance = 1;

accounting/types.proto

@@ -13,7 +13,7 @@ option csharp_namespace = "Neo.FileStorage.API.Accounting";
 // Specification](http://speleotrove.com/decimal/) for detailed problem
 // description.
 message Decimal {
-  // Number in smallest Token fractions.
+  // Number in the smallest Token fractions.
   int64 value = 1 [json_name = "value"];
 
   // Precision value indicating how many smallest fractions can be in one

acl/types.proto

@@ -15,11 +15,11 @@ enum Role {
   // User target rule is applied if sender is the owner of the container
   USER = 1;
 
-  // System target rule is applied if sender is the storage node within the
-  // container or inner ring node
+  // System target rule is applied if sender is a storage node within the
+  // container or an inner ring node
   SYSTEM = 2;
 
-  // Others target rule is applied if sender is not user nor system target
+  // Others target rule is applied if sender is neither a user nor a system target
   OTHERS = 3;
 }
 
@@ -100,7 +100,7 @@ message EACLRecord {
   // Rule execution result. Either allows or denies access if filters match.
   Action action = 2 [json_name = "action"];
 
-  // Filter to check particular properties of the request or object.
+  // Filter to check particular properties of the request or the object.
   //
   // By default `key` field refers to the corresponding object's `Attribute`.
   // Some Object's header fields can also be accessed by adding `$Object:`
@@ -160,12 +160,12 @@ message EACLRecord {
   repeated Target targets = 4 [json_name="targets"];
 }
 
-// Extended ACL rules table. Defined a list of ACL rules additionally to Basic
-// ACL. Extended ACL rules can be attached to the container and can be updated
+// Extended ACL rules table. A list of ACL rules defined additionally to Basic
+// ACL. Extended ACL rules can be attached to a container and can be updated
 // or may be defined in `BearerToken` structure. Please see the corresponding
-// NeoFS Technical Specification's section for detailed description.
+// NeoFS Technical Specification section for detailed description.
 message EACLTable {
-  // eACL format version. Effectively the version of API library used to create
+  // eACL format version. The API library version effectively used to create
   // eACL Table.
   neo.fs.v2.refs.Version version = 1 [json_name = "version"];
 
@@ -183,19 +183,19 @@ message EACLTable {
 // used in the similar use cases, like providing authorisation to externally
 // authenticated party.
 //
-// BearerToken can be issued only by container's owner and must be signed using
-// the key associated with container's `OwnerID`.
+// BearerToken can be issued only by the container's owner and must be signed using
+// the key associated with the container's `OwnerID`.
 message BearerToken {
-  // Bearer Token body structure contains Extended ACL table issued by container
-  // owner with additional information preventing token's abuse.
+  // Bearer Token body structure contains Extended ACL table issued by the container
+  // owner with additional information preventing token abuse.
   message Body {
     // Table of Extended ACL rules to use instead of the ones attached to the
     // container. If it contains `container_id` field, bearer token is only
     // valid for this specific container. Otherwise, any container of the same owner
     // is allowed.
     EACLTable eacl_table = 1 [json_name="eaclTable"];
 
-    // `OwnerID` to whom the token was issued. Must match the request
+    // `OwnerID` defines to whom the token was issued. It must match the request
     // originator's `OwnerID`. If empty, any token bearer will be accepted.
     neo.fs.v2.refs.OwnerID owner_id = 2 [json_name="ownerID"];
 

audit/types.proto

@@ -10,7 +10,7 @@ import "refs/types.proto";
 // DataAuditResult keeps record of conducted Data Audits. The detailed report is
 // generated separately.
 message DataAuditResult {
-  // Data Audit Result format version. Effectively the version of API library
+  // Data Audit Result format version. The API library version effectively
   // used to report DataAuditResult structure.
   neo.fs.v2.refs.Version version = 1 [json_name = "version"];
 
@@ -38,16 +38,16 @@ message DataAuditResult {
   // List of Storage Groups that failed audit PoR stage
   repeated neo.fs.v2.refs.ObjectID fail_sg = 9 [json_name = "failSG"];
 
-  // Number of sampled objects under audit placed in an optimal way according to
+  // Number of sampled objects under the audit placed in an optimal way according to
   // the containers placement policy when checking PoP
   uint32 hit = 10 [json_name = "hit"];
 
-  // Number of sampled objects under audit placed in suboptimal way according to
+  // Number of sampled objects under the audit placed in suboptimal way according to
   // the containers placement policy, but still at a satisfactory level when
   // checking PoP
   uint32 miss = 11 [json_name = "miss"];
 
-  // Number of sampled objects under audit stored in a way not confirming
+  // Number of sampled objects under the audit stored inconsistently with the
   // placement policy or not found at all when checking PoP
   uint32 fail = 12 [json_name = "fail"];
 

container/service.proto

@@ -17,7 +17,7 @@ import "session/types.proto";
 service ContainerService {
   // `Put` invokes `Container` smart contract's `Put` method and returns
   // response immediately. After a new block is issued in sidechain, request is
-  // verified by Inner Ring nodes. After one more block in sidechain, container
+  // verified by Inner Ring nodes. After one more block in sidechain, the container
   // is added into smart contract storage.
   //
   // Statuses:
@@ -28,7 +28,7 @@ service ContainerService {
 
   // `Delete` invokes `Container` smart contract's `Delete` method and returns
   // response immediately. After a new block is issued in sidechain, request is
-  // verified by Inner Ring nodes. After one more block in sidechain, container
+  // verified by Inner Ring nodes. After one more block in sidechain, the container
   // is added into smart contract storage.
   //
   // Statuses:
@@ -56,7 +56,7 @@ service ContainerService {
   rpc List(ListRequest) returns (ListResponse);
 
   // Invokes 'SetEACL' method of 'Container` smart contract and returns response
-  // immediately. After one more block in sidechain, Extended ACL changes are
+  // immediately. After one more block in sidechain, changes in an Extended ACL are
   // added into smart contract storage.
   //
   // Statuses:
@@ -76,7 +76,7 @@ service ContainerService {
   //   container not found.
   rpc GetExtendedACL(GetExtendedACLRequest) returns (GetExtendedACLResponse);
 
-  // Announce container used space values for P2P synchronization.
+  // Announces the space values used by the container for P2P synchronization.
   //
   // Statuses:
   // - **OK** (0, SECTION_SUCCESS): \
@@ -117,7 +117,7 @@ message PutResponse {
   // Container put response body contains information about the newly registered
   // container as seen by `Container` smart contract. `ContainerID` can be
   // calculated beforehand from the container structure and compared to the one
-  // returned here to make sure everything was done as expected.
+  // returned here to make sure everything has been done as expected.
   message Body {
     // Unique identifier of the newly created container
     neo.fs.v2.refs.ContainerID container_id = 1;
@@ -137,8 +137,8 @@ message PutResponse {
 
 // Container removal request
 message DeleteRequest {
-  // Container removal request body has a signed `ContainerID` as a proof of
-  // container owner's intent. The signature will be verified by `Container`
+  // Container removal request body has signed `ContainerID` as a proof of
+  // the container owner's intent. The signature will be verified by `Container`
   // smart contract, so signing algorithm must be supported by NeoVM.
   message Body {
     // Identifier of the container to delete from NeoFS
@@ -202,15 +202,15 @@ message GetRequest {
 // Get container structure
 message GetResponse {
   // Get container response body does not have container structure signature. It
-  // was already verified on container creation.
+  // has been already verified upon container creation.
   message Body {
     // Requested container structure
     Container container = 1;
 
     // Signature of a stable-marshalled container according to RFC-6979.
     neo.fs.v2.refs.SignatureRFC6979 signature = 2;
 
-    // Session token if the container was created within a session
+    // Session token if the container has been created within the session
     neo.fs.v2.session.SessionToken session_token = 3;
   }
   // Body of container get response message.
@@ -272,7 +272,7 @@ message SetExtendedACLRequest {
   // Set Extended ACL request body does not have separate `ContainerID`
   // reference. It will be taken from `EACLTable.container_id` field.
   message Body {
-    // Extended ACL table to set for container
+    // Extended ACL table to set for the container
     neo.fs.v2.acl.EACLTable eacl = 1;
 
     // Signature of stable-marshalled Extended ACL table according to RFC-6979.
@@ -294,7 +294,7 @@ message SetExtendedACLRequest {
 // Set Extended ACL
 message SetExtendedACLResponse {
   // `SetExtendedACLResponse` has an empty body because the operation is
-  // asynchronous and update should be reflected in `Container` smart contract's
+  // asynchronous and the update should be reflected in `Container` smart contract's
   // storage after next block is issued in sidechain.
   message Body { }
 
@@ -334,9 +334,9 @@ message GetExtendedACLRequest {
 
 // Get Extended ACL
 message GetExtendedACLResponse {
-  // Get Extended ACL Response body can be empty if the requested container did
-  // not have Extended ACL Table attached or Extended ACL was not allowed at
-  // container creation.
+  // Get Extended ACL Response body can be empty if the requested container does
+  // not have Extended ACL Table attached or Extended ACL has not been allowed at
+  // the time of container creation.
   message Body {
     // Extended ACL requested, if available
     neo.fs.v2.acl.EACLTable eacl = 1;
@@ -364,21 +364,21 @@ message GetExtendedACLResponse {
 message AnnounceUsedSpaceRequest {
   // Container used space announcement body.
   message Body {
-    // Announcement contains used space information about single container.
+    // Announcement contains used space information for a single container.
     message Announcement {
-      // Epoch number for which container size estimation was produced.
+      // Epoch number for which the container size estimation was produced.
       uint64 epoch = 1;
 
       // Identifier of the container.
       neo.fs.v2.refs.ContainerID container_id = 2;
 
-      // Used space is a sum of object payload sizes of specified
+      // Used space is a sum of object payload sizes of a specified
       // container, stored in the node. It must not include inhumed objects.
       uint64 used_space = 3;
     }
 
-    // List of announcements. If nodes share several containers, then
-    // announcements transferred in a batch.
+    // List of announcements. If nodes share several containers,
+    // announcements are transferred in a batch.
     repeated Announcement announcements = 1;
   }
 

container/types.proto

@@ -10,11 +10,11 @@ import "refs/types.proto";
 
 // Container is a structure that defines object placement behaviour. Objects can
 // be stored only within containers. They define placement rule, attributes and
-// access control information. ID of the container is a 32 byte long SHA256 hash
+// access control information. An ID of a container is a 32 byte long SHA256 hash
 // of stable-marshalled container message.
 message Container {
-  // Container format version. Effectively the version of API library used to
-  // create container.
+  // Container format version. The API library version effectively used to
+  // create the container.
   neo.fs.v2.refs.Version version = 1 [json_name = "version"];
 
   // Identifier of the container owner
@@ -23,13 +23,13 @@ message Container {
   // Nonce is a 16 byte UUIDv4, used to avoid collisions of `ContainerID`s
   bytes nonce = 3 [json_name = "nonce"];
 
-  // `BasicACL` contains access control rules for owner, system, others groups
-  // and permission bits for `BearerToken` and `Extended ACL`
+  // `BasicACL` contains access control rules for the owner, system and others groups,
+  // as well as permission bits for `BearerToken` and `Extended ACL`
   uint32 basic_acl = 4 [json_name = "basicACL"];
 
   // `Attribute` is a user-defined Key-Value metadata pair attached to the
-  // container. Container attributes are immutable. They are set at container
-  // creation and can never be added or updated.
+  // container. Container attributes are immutable. They are set at the moment of
+  // container creation and can never be added or updated.
   //
   // Key name must be a container-unique valid UTF-8 string. Value can't be
   // empty. Containers with duplicated attribute names or attributes with empty
@@ -38,14 +38,14 @@ message Container {
   // There are some "well-known" attributes affecting system behaviour:
   //
   // * __NEOFS__SUBNET \
-  //   String ID of container's storage subnet. Container can be attached to
-  //   only one subnet.
+  //   String ID of a container's storage subnet. Any container can be attached to
+  //   one subnet only.
   // * __NEOFS__NAME \
-  //   String of human-friendly container name registered as the domain in
+  //   String of a human-friendly container name registered as a domain in
   //   NNS contract.
   // * __NEOFS__ZONE \
-  //   String of zone for `__NEOFS__NAME`. Used as TLD of domain name in NNS
-  //   contract. If zone is not specified, use default zone: `container`.
+  //   String of a zone for `__NEOFS__NAME`. Used as a TLD of a domain name in NNS
+  //   contract. If no zone is specified, use default zone: `container`.
   //
   // And some well-known attributes used by applications only:
   //

doc/release_instructions.md

@@ -1,25 +1,25 @@
 # Release instructions
 
-This documents outlines the neofs-api release process, and can be used as a TODO
+This documents outlines the neofs-api release process and can be used as a TODO
 list for a new release.
 
 ## Pre-release checks
 
-These should run successfully:
+This should run successfully:
 * `make lint`
 
 ## Pre-release actions
 
-These must be run:
+This must be run:
 * `make doc`
 
 ## Writing CHANGELOG
 
 Add an entry to the CHANGELOG.md following the style established there.
 
-Add a codename for releases with new major version, version and release date in
+Add a codename for releases with the new major version, version and release date in
 the heading. Write a paragraph describing the most significant changes done in
-this release. Then add sections with what was added, changed and removed,
+this release. Then add sections with what has been added, changed and removed,
 describing each change briefly with a reference to GitHub issues, where
 available.
 

lock/types.proto

@@ -7,7 +7,7 @@ option csharp_namespace = "Neo.FileStorage.API.Lock";
 
 import "refs/types.proto";
 
-// Lock objects protects a list of objects from being deleted. Lifetime of the
+// Lock objects protects a list of objects from being deleted. The lifetime of a
 // lock object is limited similar to regular objects in
 // `__NEOFS__EXPIRATION_EPOCH` attribute.
 message Lock {