From b0922c6a6d1fe76e5521c8eb9512c9628bc5b5d2 Mon Sep 17 00:00:00 2001 From: Daniel Molloy Date: Sat, 20 Nov 2021 11:15:29 +0000 Subject: [PATCH] I made a start on vale prose fixes --- .../vendr-core-models/productattributepresetreadonly.md | 2 +- .../reference/vendr-core-models/productvariantcollection.md | 2 +- .../1.6.0/reference/vendr-web-propertyeditors/README.md | 2 +- .../vendr-web-propertyeditors/variantseditorcomponent.md | 2 +- content/core/1.7.0/key-concepts/search-specifications.md | 6 +++--- .../reference/vendr-core-configuration/ivendrsettings.md | 4 ++-- .../vendr-core-models/productattributepresetreadonly.md | 2 +- .../reference/vendr-core-models/productvariantcollection.md | 2 +- .../1.7.0/reference/vendr-core-services/iorderservice.md | 4 ++-- .../1.7.0/reference/vendr-web-propertyeditors/README.md | 2 +- .../vendr-web-propertyeditors/variantseditorcomponent.md | 2 +- content/core/1.8.0/key-concepts/bulk-actions.md | 6 +++--- content/core/1.8.0/key-concepts/search-specifications.md | 6 +++--- .../reference/vendr-core-configuration/ivendrsettings.md | 4 ++-- .../vendr-core-models/productattributepresetreadonly.md | 2 +- .../reference/vendr-core-models/productvariantcollection.md | 2 +- .../1.8.0/reference/vendr-core-services/iorderservice.md | 4 ++-- .../1.8.0/reference/vendr-core-services/istockservice.md | 2 +- 18 files changed, 28 insertions(+), 28 deletions(-) diff --git a/content/core/1.6.0/reference/vendr-core-models/productattributepresetreadonly.md b/content/core/1.6.0/reference/vendr-core-models/productattributepresetreadonly.md index b82de4a9..6bc8d880 100644 --- a/content/core/1.6.0/reference/vendr-core-models/productattributepresetreadonly.md +++ b/content/core/1.6.0/reference/vendr-core-models/productattributepresetreadonly.md @@ -35,7 +35,7 @@ public string Alias { get; } #### AllowedAttributes -Gets the list of allowed Product Attribtues for this Product Attribute Preset +Gets the list of allowed Product Attributes for this Product Attribute Preset ```csharp public IReadOnlyCollection AllowedAttributes { get; } diff --git a/content/core/1.6.0/reference/vendr-core-models/productvariantcollection.md b/content/core/1.6.0/reference/vendr-core-models/productvariantcollection.md index 5b358f28..6f15b634 100644 --- a/content/core/1.6.0/reference/vendr-core-models/productvariantcollection.md +++ b/content/core/1.6.0/reference/vendr-core-models/productvariantcollection.md @@ -25,7 +25,7 @@ public ProductVariantCollection(Guid storeId, IList list) | Parameter | Description | | --- | --- | -| storeId | The StoreId the product variants belogn to | +| storeId | The StoreId the product variants belong to | | list | The list to wrap. | diff --git a/content/core/1.6.0/reference/vendr-web-propertyeditors/README.md b/content/core/1.6.0/reference/vendr-web-propertyeditors/README.md index e8a81360..79fdadd9 100644 --- a/content/core/1.6.0/reference/vendr-web-propertyeditors/README.md +++ b/content/core/1.6.0/reference/vendr-web-propertyeditors/README.md @@ -13,7 +13,7 @@ description: API reference for Vendr.Web.PropertyEditors in Vendr, the eCommerce | Public Type | Description | | --- | --- | -| class [VariantsEditorComponent](variantseditorcomponent/) | Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSycn too. We could also look to potetially use this in the value converter for the variants editor as we now have this also being store aware. | +| class [VariantsEditorComponent](variantseditorcomponent/) | Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSync too. We could also look to potentially use this in the value converter for the variants editor as we now have this also being store aware. | | class [VariantsEditorComposer](variantseditorcomposer/) | | | class [VariantsEditorConfiguration](variantseditorconfiguration/) | | | class [VariantsEditorDataConverter](variantseditordataconverter/) | | diff --git a/content/core/1.6.0/reference/vendr-web-propertyeditors/variantseditorcomponent.md b/content/core/1.6.0/reference/vendr-web-propertyeditors/variantseditorcomponent.md index 1b9d5db6..6639fd7e 100644 --- a/content/core/1.6.0/reference/vendr-web-propertyeditors/variantseditorcomponent.md +++ b/content/core/1.6.0/reference/vendr-web-propertyeditors/variantseditorcomponent.md @@ -4,7 +4,7 @@ description: API reference for VariantsEditorComponent in Vendr, the eCommerce s --- ## VariantsEditorComponent -Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSycn too. We could also look to potetially use this in the value converter for the variants editor as we now have this also being store aware. +Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSync too. We could also look to potentially use this in the value converter for the variants editor as we now have this also being store aware. ```csharp public class VariantsEditorComponent : IComponent diff --git a/content/core/1.7.0/key-concepts/search-specifications.md b/content/core/1.7.0/key-concepts/search-specifications.md index b0a6f00e..d9ece749 100644 --- a/content/core/1.7.0/key-concepts/search-specifications.md +++ b/content/core/1.7.0/key-concepts/search-specifications.md @@ -26,9 +26,9 @@ var results = _orderService.SearchOrders( .And(where.HasOrderNumber(orderNumber).Or(where.ByCustomer(customerEmail)))) ```` -The above is relatively simple example but it demonstrates the use of a delegate method that then uses a fluent specifications API to build up a query filter. The query filter itself can be made up of many different individual queries which themselves can be grouped using AND and OR query logic. +The above is a relatively simple example, but it demonstrates the use of a delegate method that then uses a fluent specifications API to build up a query filter. The query filter itself can be made up of many different individual queries, which themselves can be grouped using AND and OR query logic. -Because the API is fluent it is also self documenting, with Visual Studio intellisense able to guide developers through all the available specifications. +Because the API is fluent, it is also self-documenting, with Visual Studio Intellisense able to guide developers through all the available specifications. ## Ordering Results @@ -42,4 +42,4 @@ var results = _orderService.SearchOrders( (orderBy) => orderBy .FinalizedDate(Sort.Descending) .Then(orderBy.CreateDate(Sort.Descending))) -```` \ No newline at end of file +```` diff --git a/content/core/1.7.0/reference/vendr-core-configuration/ivendrsettings.md b/content/core/1.7.0/reference/vendr-core-configuration/ivendrsettings.md index ad30937d..35819d7c 100644 --- a/content/core/1.7.0/reference/vendr-core-configuration/ivendrsettings.md +++ b/content/core/1.7.0/reference/vendr-core-configuration/ivendrsettings.md @@ -17,7 +17,7 @@ public interface IVendrSettings #### BackOfficeMvcArea -Gets the back office MVC area under which Vendr is installed +Gets the backoffice MVC area under which Vendr is installed ```csharp public string BackOfficeMvcArea { get; } @@ -28,7 +28,7 @@ public string BackOfficeMvcArea { get; } #### BackOfficePath -Gets the back office path for this Vendr install +Gets the backoffice path for this Vendr install ```csharp public string BackOfficePath { get; } diff --git a/content/core/1.7.0/reference/vendr-core-models/productattributepresetreadonly.md b/content/core/1.7.0/reference/vendr-core-models/productattributepresetreadonly.md index b82de4a9..6bc8d880 100644 --- a/content/core/1.7.0/reference/vendr-core-models/productattributepresetreadonly.md +++ b/content/core/1.7.0/reference/vendr-core-models/productattributepresetreadonly.md @@ -35,7 +35,7 @@ public string Alias { get; } #### AllowedAttributes -Gets the list of allowed Product Attribtues for this Product Attribute Preset +Gets the list of allowed Product Attributes for this Product Attribute Preset ```csharp public IReadOnlyCollection AllowedAttributes { get; } diff --git a/content/core/1.7.0/reference/vendr-core-models/productvariantcollection.md b/content/core/1.7.0/reference/vendr-core-models/productvariantcollection.md index 5b358f28..6f15b634 100644 --- a/content/core/1.7.0/reference/vendr-core-models/productvariantcollection.md +++ b/content/core/1.7.0/reference/vendr-core-models/productvariantcollection.md @@ -25,7 +25,7 @@ public ProductVariantCollection(Guid storeId, IList list) | Parameter | Description | | --- | --- | -| storeId | The StoreId the product variants belogn to | +| storeId | The StoreId the product variants belong to | | list | The list to wrap. | diff --git a/content/core/1.7.0/reference/vendr-core-services/iorderservice.md b/content/core/1.7.0/reference/vendr-core-services/iorderservice.md index 581dc1d5..c4659121 100644 --- a/content/core/1.7.0/reference/vendr-core-services/iorderservice.md +++ b/content/core/1.7.0/reference/vendr-core-services/iorderservice.md @@ -294,7 +294,7 @@ public PagedResult SearchOrders(IQuerySpecification SearchOrders( | Parameter | Description | | --- | --- | | query | The factory method to generate the query specification to perform | -| sort | The factory method to generate the sort order specification describinng the sort order in which to return the results | +| sort | The factory method to generate the sort order specification describing the sort order in which to return the results | | currentPage | The page of results of which to retrieve | | itemsPerPage | The number of items per page to return | diff --git a/content/core/1.7.0/reference/vendr-web-propertyeditors/README.md b/content/core/1.7.0/reference/vendr-web-propertyeditors/README.md index e8a81360..79fdadd9 100644 --- a/content/core/1.7.0/reference/vendr-web-propertyeditors/README.md +++ b/content/core/1.7.0/reference/vendr-web-propertyeditors/README.md @@ -13,7 +13,7 @@ description: API reference for Vendr.Web.PropertyEditors in Vendr, the eCommerce | Public Type | Description | | --- | --- | -| class [VariantsEditorComponent](variantseditorcomponent/) | Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSycn too. We could also look to potetially use this in the value converter for the variants editor as we now have this also being store aware. | +| class [VariantsEditorComponent](variantseditorcomponent/) | Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSync too. We could also look to potentially use this in the value converter for the variants editor as we now have this also being store aware. | | class [VariantsEditorComposer](variantseditorcomposer/) | | | class [VariantsEditorConfiguration](variantseditorconfiguration/) | | | class [VariantsEditorDataConverter](variantseditordataconverter/) | | diff --git a/content/core/1.7.0/reference/vendr-web-propertyeditors/variantseditorcomponent.md b/content/core/1.7.0/reference/vendr-web-propertyeditors/variantseditorcomponent.md index 1b9d5db6..6639fd7e 100644 --- a/content/core/1.7.0/reference/vendr-web-propertyeditors/variantseditorcomponent.md +++ b/content/core/1.7.0/reference/vendr-web-propertyeditors/variantseditorcomponent.md @@ -4,7 +4,7 @@ description: API reference for VariantsEditorComponent in Vendr, the eCommerce s --- ## VariantsEditorComponent -Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSycn too. We could also look to potetially use this in the value converter for the variants editor as we now have this also being store aware. +Component to watch for content changes to nodes with a variants editor on them and stash a storeId property in the data structure. This is predominantly for Vendr Deploy which needs to lookup Product Attribute dependencies but needs as storeId to do it however the Umbraco Deploy value connectors don't have any other context other than the property value and it's property type. This may also be true for uSync too. We could also look to potentially use this in the value converter for the variants editor as we now have this also being store aware. ```csharp public class VariantsEditorComponent : IComponent diff --git a/content/core/1.8.0/key-concepts/bulk-actions.md b/content/core/1.8.0/key-concepts/bulk-actions.md index c2b42619..1557bb23 100644 --- a/content/core/1.8.0/key-concepts/bulk-actions.md +++ b/content/core/1.8.0/key-concepts/bulk-actions.md @@ -77,7 +77,7 @@ Once created, the bulk action will then be displayed in the bulk actions bar for | `getConfirmMessage(total)` | A function that can provider a message to display before a bulk action is triggered should confirmation be required for the action to run. Returns an Promise that returns a string. | | `getStatusMessage(count, total)` | A function used to provider a status message after each item has been processed. Displayed in the bulk actions bar after each `itemAction` has been called. Returns an Promise that returns a string. | | `getSuccessMessage(total)` | A function to return a success message after all bulk actions have been performed. Returns an Promise that returns a string. | -| `condition(context)` | As all bulk actions are registered globally for all entity types, the `condition` function can be used to filer when, and for which entities a bulk action will actually display. | +| `condition(context)` | As all bulk actions are registered globally for all entity types, the `condition` function can be used to filter when, and for which entities a bulk action will display. | † Only a `itemAction` OR a `bulkAction` method should be defined for a bulk action configuration. If both are present, the `bulkAction` will be used and the `itemAction` will be ignored. If processing of items can be done individually, it is better to use the `itemAction` in order to provider user feedback. `bulkAction` should only be used where items need to be processed in a single action. @@ -85,7 +85,7 @@ Once created, the bulk action will then be displayed in the bulk actions bar for * Most methods apart from `itemAction` or `bulkAction` are optional. If methods aren't present, a default implementation will be used, or, where those methods trigger specific functionality such as the `configure` or `getConfirmMessage` methods, that functionality will become disabled. * It's important to note the array based syntax for registering a bulk action with angular dependencies. Each bulk action is registered as an array, where all dependencies are defined first and then a factory function is defined last which returns the actual bulk action definition. -* Whilst these docs outline how to define a bulk action, you will likely need to register further resources / services that can actually perform the given bulk operation and include these as a dependency for your action. +* Whilst these docs outline how to define a bulk action, you will likely need to register further resources/services that can perform the given bulk operation and include these as a dependency for your action. ## Examples @@ -130,4 +130,4 @@ angular.module('vendr') }]); }]): -```` \ No newline at end of file +```` diff --git a/content/core/1.8.0/key-concepts/search-specifications.md b/content/core/1.8.0/key-concepts/search-specifications.md index b0a6f00e..d9ece749 100644 --- a/content/core/1.8.0/key-concepts/search-specifications.md +++ b/content/core/1.8.0/key-concepts/search-specifications.md @@ -26,9 +26,9 @@ var results = _orderService.SearchOrders( .And(where.HasOrderNumber(orderNumber).Or(where.ByCustomer(customerEmail)))) ```` -The above is relatively simple example but it demonstrates the use of a delegate method that then uses a fluent specifications API to build up a query filter. The query filter itself can be made up of many different individual queries which themselves can be grouped using AND and OR query logic. +The above is a relatively simple example, but it demonstrates the use of a delegate method that then uses a fluent specifications API to build up a query filter. The query filter itself can be made up of many different individual queries, which themselves can be grouped using AND and OR query logic. -Because the API is fluent it is also self documenting, with Visual Studio intellisense able to guide developers through all the available specifications. +Because the API is fluent, it is also self-documenting, with Visual Studio Intellisense able to guide developers through all the available specifications. ## Ordering Results @@ -42,4 +42,4 @@ var results = _orderService.SearchOrders( (orderBy) => orderBy .FinalizedDate(Sort.Descending) .Then(orderBy.CreateDate(Sort.Descending))) -```` \ No newline at end of file +```` diff --git a/content/core/1.8.0/reference/vendr-core-configuration/ivendrsettings.md b/content/core/1.8.0/reference/vendr-core-configuration/ivendrsettings.md index ad30937d..35819d7c 100644 --- a/content/core/1.8.0/reference/vendr-core-configuration/ivendrsettings.md +++ b/content/core/1.8.0/reference/vendr-core-configuration/ivendrsettings.md @@ -17,7 +17,7 @@ public interface IVendrSettings #### BackOfficeMvcArea -Gets the back office MVC area under which Vendr is installed +Gets the backoffice MVC area under which Vendr is installed ```csharp public string BackOfficeMvcArea { get; } @@ -28,7 +28,7 @@ public string BackOfficeMvcArea { get; } #### BackOfficePath -Gets the back office path for this Vendr install +Gets the backoffice path for this Vendr install ```csharp public string BackOfficePath { get; } diff --git a/content/core/1.8.0/reference/vendr-core-models/productattributepresetreadonly.md b/content/core/1.8.0/reference/vendr-core-models/productattributepresetreadonly.md index b82de4a9..6bc8d880 100644 --- a/content/core/1.8.0/reference/vendr-core-models/productattributepresetreadonly.md +++ b/content/core/1.8.0/reference/vendr-core-models/productattributepresetreadonly.md @@ -35,7 +35,7 @@ public string Alias { get; } #### AllowedAttributes -Gets the list of allowed Product Attribtues for this Product Attribute Preset +Gets the list of allowed Product Attributes for this Product Attribute Preset ```csharp public IReadOnlyCollection AllowedAttributes { get; } diff --git a/content/core/1.8.0/reference/vendr-core-models/productvariantcollection.md b/content/core/1.8.0/reference/vendr-core-models/productvariantcollection.md index 5b358f28..6f15b634 100644 --- a/content/core/1.8.0/reference/vendr-core-models/productvariantcollection.md +++ b/content/core/1.8.0/reference/vendr-core-models/productvariantcollection.md @@ -25,7 +25,7 @@ public ProductVariantCollection(Guid storeId, IList list) | Parameter | Description | | --- | --- | -| storeId | The StoreId the product variants belogn to | +| storeId | The StoreId the product variants belong to | | list | The list to wrap. | diff --git a/content/core/1.8.0/reference/vendr-core-services/iorderservice.md b/content/core/1.8.0/reference/vendr-core-services/iorderservice.md index 581dc1d5..c4659121 100644 --- a/content/core/1.8.0/reference/vendr-core-services/iorderservice.md +++ b/content/core/1.8.0/reference/vendr-core-services/iorderservice.md @@ -294,7 +294,7 @@ public PagedResult SearchOrders(IQuerySpecification SearchOrders( | Parameter | Description | | --- | --- | | query | The factory method to generate the query specification to perform | -| sort | The factory method to generate the sort order specification describinng the sort order in which to return the results | +| sort | The factory method to generate the sort order specification describing the sort order in which to return the results | | currentPage | The page of results of which to retrieve | | itemsPerPage | The number of items per page to return | diff --git a/content/core/1.8.0/reference/vendr-core-services/istockservice.md b/content/core/1.8.0/reference/vendr-core-services/istockservice.md index 0bea06f4..d0e32d79 100644 --- a/content/core/1.8.0/reference/vendr-core-services/istockservice.md +++ b/content/core/1.8.0/reference/vendr-core-services/istockservice.md @@ -195,7 +195,7 @@ public void SetStock(string productReference, string productVariantReference, de #### TryGetStock (1 of 2) -Trys to get the stock level of a given product +Tries to get the stock level of a given product ```csharp public bool TryGetStock(string productReference, out decimal? stock)