Correct the verb agreement and noun numbers#1695
Correct the verb agreement and noun numbers#1695Adarsh7898 wants to merge 1 commit intohotwax:user-guides-pubfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the transfer order lifecycle documentation by pluralizing "inventory count" to "inventory counts" across several sections to improve grammatical consistency. The review feedback identifies further opportunities to align the content with the HotWax Style Guide, specifically recommending the use of active voice to make instructions more direct, pruning excess words like "subsequently," and ensuring consistent terminology for "item fulfillment records."
|
|
||
| * A scheduled SuiteScript in NetSuite reads the item receipt feed and two actions take place: | ||
| * Item receipt records are created in NetSuite and subsequently, inventory count at the store for the corresponding items are increased. | ||
| * Item receipt records are created in NetSuite and subsequently, inventory counts at the store for the corresponding items are increased. |
There was a problem hiding this comment.
The style guide recommends using active voice to keep content clear and direct (line 329). Additionally, removing "subsequently" helps prune excess words (line 47).
| * Item receipt records are created in NetSuite and subsequently, inventory counts at the store for the corresponding items are increased. | |
| * NetSuite creates item receipt records and increases inventory counts at the store for the corresponding items. |
|
|
||
| * A scheduled SuiteScript in NetSuite reads the fulfilled transfer order items feed and two actions take place: | ||
| * Item fulfilled records are created in NetSuite and marked <mark style="color:orange;">**“Shipped”**</mark>. Subsequently, inventory count at the store for the corresponding items are reduced. | ||
| * Item fulfilled records are created in NetSuite and marked <mark style="color:orange;">**“Shipped”**</mark>. Subsequently, inventory counts at the store for the corresponding items are reduced. |
There was a problem hiding this comment.
Use "item fulfillment records" instead of "Item fulfilled records" to maintain consistency with the section heading (line 79) and the rest of the document, adhering to the "Use one term for one concept everywhere" rule (line 91). Additionally, using active voice makes the instructions more direct (line 329).
| * Item fulfilled records are created in NetSuite and marked <mark style="color:orange;">**“Shipped”**</mark>. Subsequently, inventory counts at the store for the corresponding items are reduced. | |
| * NetSuite creates item fulfillment records, marks them <mark style="color:orange;">**“Shipped”**</mark>, and reduces inventory counts at the store for the corresponding items. |
|
|
||
| * A scheduled SuiteScript in NetSuite reads the item receipt feed and two actions take place: | ||
| * Item receipt records are created in NetSuite and subsequently, inventory count at the store for the corresponding items are increased. | ||
| * Item receipt records are created in NetSuite and subsequently, inventory counts at the store for the corresponding items are increased. |
There was a problem hiding this comment.
Using active voice makes the sentence more direct and clear, as recommended by the style guide (line 329).
| * Item receipt records are created in NetSuite and subsequently, inventory counts at the store for the corresponding items are increased. | |
| * NetSuite creates item receipt records and increases inventory counts at the store for the corresponding items. |
References
- Prefer active voice to keep content clear and direct. (link)
|
|
||
| * Finally, the inventory planning team manually initiates the receiving process in NetSuite for the store transferred inventory upon its arrival at the warehouse. | ||
| * After the receiving process is completed, the transfer order status is automatically updated from <mark style="color:orange;">**“Pending Receipt”**</mark> to <mark style="color:orange;">**“Received”**</mark>, indicating that all transfer order items have been successfully received at the warehouse. Additionally, the inventory count for the newly received inventory is updated in NetSuite. | ||
| * After the receiving process is completed, the transfer order status is automatically updated from <mark style="color:orange;">**“Pending Receipt”**</mark> to <mark style="color:orange;">**“Received”**</mark>, indicating that all transfer order items have been successfully received at the warehouse. Additionally, the inventory counts for the newly received inventory are updated in NetSuite. |
There was a problem hiding this comment.
This sentence can be made more concise and direct by using active voice and removing redundant phrases, adhering to the "Crisp and clear" principle (line 35) and "Prune excess words" (line 47).
| * After the receiving process is completed, the transfer order status is automatically updated from <mark style="color:orange;">**“Pending Receipt”**</mark> to <mark style="color:orange;">**“Received”**</mark>, indicating that all transfer order items have been successfully received at the warehouse. Additionally, the inventory counts for the newly received inventory are updated in NetSuite. | |
| * After the receiving process is complete, NetSuite automatically updates the transfer order status from <mark style="color:orange;">**“Pending Receipt”**</mark> to <mark style="color:orange;">**“Received”**</mark> and updates the inventory counts for the newly received inventory. |
1 participant
Corrected noun usage by replacing “inventory count” with “inventory counts” in relevant sections to ensure consistency and proper verb agreement.
Fixes: Verb Agreement Errors in Transfer Order Documentation #1691