Fix common spelling mistakes (#4956)

* add codespell

* first fixes

* doc fixes

* fix docstrings and comments

* functional changes

* docstrings again

* and docs again

* rename args

* add ignore

* use pre-commit for filtering instead

* ups

* fix typo in filter

docs/README.md

@@ -68,7 +68,7 @@ Images are served from the `./docs/assets/images` folder and can be added as fol
 ```
 
 Replace:
-* `image_id` with a short unique indentifier for the image (most commonly, `image_id` is same as `image_name`)
+* `image_id` with a short unique identifier for the image (most commonly, `image_id` is same as `image_name`)
 * `folder` with the folder in `docs/assets/images` in which the image is stored
 * `image_name` with the name of the image
 * `.png` with the image extension (PNG or JPEG are preferred formats)

docs/docs/api/python/examples.md

@@ -15,7 +15,7 @@ from inventree.part import Part, PartCategory
 from inventree.stock import StockItem
 
 ## Create a new PartCategory object,
-## underneath the existing category with pk 7. Leave the parent empty fpr a top level category
+## underneath the existing category with pk 7. Leave the parent empty for a top level category
 furniture = PartCategory.create(api, {
     'name': 'Furniture',
     'description': 'Chairs, tables, etc',

docs/docs/api/python/python.md

@@ -115,7 +115,7 @@ parent_categories = PartCategory.list(api, parent='')
 
 ### Item Attributes
 
-The available model attributes are determined by introspecting [API metadata](../metadata.md). To view the fields (attributes) availabel for a given database model type within the python interface, use the `fieldNames` and `fieldInfo` methods, as below:
+The available model attributes are determined by introspecting [API metadata](../metadata.md). To view the fields (attributes) available for a given database model type within the python interface, use the `fieldNames` and `fieldInfo` methods, as below:
 
 ```python
 from inventree.api import InvenTreeAPI

docs/docs/app/privacy.md

@@ -40,7 +40,7 @@ The InvenTree app does not share any personal information on users of the app wi
 The InvenTree app makes use of the [sentry.io](https://sentry.io/) service to monitor the app for bugs and run-time errors. When an error occurs in the app, log data is uploaded to the sentry server, where InvenTree developers can use this information to improve the quality of the app.
 
 !!! question "Identifying Information"
-    The uploaded error reports contain information on the nature of the error / bug; i.e. "where" in the app code the failures occured. The uploaded data does not contain any information which can be used to identify users or extract user data.
+    The uploaded error reports contain information on the nature of the error / bug; i.e. "where" in the app code the failures occurred. The uploaded data does not contain any information which can be used to identify users or extract user data.
 
 !!! tip "Disable Error Reporting"
     If desired, users can disable error reporting entirely, from within the [app settings](./settings.md). This prevents any error logs from being uploaded to the sentry server.

docs/docs/build/allocate.md

@@ -112,7 +112,7 @@ Set this option to *True* to signal that stock items can be used interchangeably
 
 **Substitute Stock**
 
-Set this option to *True* to allow substitute parts (as specifed by the BOM) to be allocated, if the primary parts are not available.
+Set this option to *True* to allow substitute parts (as specified by the BOM) to be allocated, if the primary parts are not available.
 
 ## Allocating Tracked Stock
 

docs/docs/build/bom.md

@@ -58,7 +58,7 @@ When using the InvenTree [template / variant](../part/template.md) feature, it m
 
 If a BOM Line Item is designed as *Inherited*, it will be automatically included in the BOM of any part which is a variant (or sub-variant) of the part for which the BOM Line Item is defined.
 
-This is particulary useful if a template part is defined with the "common" BOM items which exist for all variants of that template.
+This is particularly useful if a template part is defined with the "common" BOM items which exist for all variants of that template.
 
 Consider the example diagram below:
 
@@ -140,7 +140,7 @@ To process with BOM validation, click on the <span class='fas fa-clipboard-check
 
 ## Multi Level BOMs
 
-Multi-level (hierarchical) BOMs are natively supported by InvenTree. A Bill of Materials (BOM) can contain sub-assemblies which themselves have a defined BOM. This can continue for an unlimted number of levels.
+Multi-level (hierarchical) BOMs are natively supported by InvenTree. A Bill of Materials (BOM) can contain sub-assemblies which themselves have a defined BOM. This can continue for an unlimited number of levels.
 
 When viewing a BOM table, sub-assemblies are not loaded by default, but can be loaded "on demand" by pressing the <span class='fas fa-sync-alt'></span> icon associated with the particular subassembly:
 

docs/docs/build/build.md

@@ -83,7 +83,7 @@ Each *Build Order* has an associated *Status* flag, which indicates the state of
 
 When a *Build Order* is created, we then have the ability to *allocate* stock items against that build order. The particular parts we need to allocate against the build are specified by the BOM for the part we are assembling.
 
-- A *Stock Alloction* links a certain quantity of a given *Stock Item* to the build.
+- A *Stock Allocation* links a certain quantity of a given *Stock Item* to the build.
 - At least one stock allocation is required for each line in the BOM
 - Multiple stock allocations can be made against a BOM line if a particular stock item does not have sufficient quantity for the build
 
@@ -198,7 +198,7 @@ To complete a build, click on <span class='fas fa-tools'></span> icon on the bui
 The form will validate the build order is ready to be completed, and will prevent you from continuing if any of the below conditions are present unless you select one of the presented options to override the validation and accept completion of the build anyway.
 
 !!! info "Incomplete Build"
-	If the warning message `Required build quantity has not been completed` is shown, you have build ouputs that have not yet been completed.
+	If the warning message `Required build quantity has not been completed` is shown, you have build outputs that have not yet been completed.
 
 	In the unlikely event that you wish to proceed despite this, you can toggle the `Accept Incomplete` option to true to override the error and allow completion without the required number of build outputs.
 

docs/docs/credits.md

@@ -58,7 +58,7 @@ InvenTree relies on the following frontend libraries and components:
 | [Font Awesome - Icons](https://fontawesome.com/) | CC BY 4.0 License | Icons |
 | [Font Awesome - Code](https://fontawesome.com/) | MIT | Delivery code for icons |
 | [Select2](https://github.com/select2/select2/) | MIT | Searchable selection box |
-| [fullcalendar](https://github.com/fullcalendar/fullcalendar/) | MIT | Calender rendering |
+| [fullcalendar](https://github.com/fullcalendar/fullcalendar/) | MIT | Calendar rendering |
 | [chart.js](https://github.com/chartjs/Chart.js) | MIT | charts |
 | [Moment JS](https://github.com/moment/momentjs.com/) | MIT | Time and date rendering |
 | [jquery-treegrid](https://github.com/maxazan/jquery-treegrid/) | MIT | Treegrid rendering |

docs/docs/extend/how_to_plugin.md

@@ -18,7 +18,7 @@ If you add a lot of code (over ~1000 LOC) maybe split it into multiple plugins t
 Great. Now please read the [plugin documentation](./plugins.md) to get an overview of the architecture. It is rather short as a the (builtin) mixins come with extensive docstrings.
 
 ### Pick your building blocks
-Consider the usecase for your plugin and define the exact function of the plugin, maybe wrtie it down in a short readme. Then pick the mixins you need (they help reduce custom code and keep the system reliable if internal calls change).
+Consider the usecase for your plugin and define the exact function of the plugin, maybe write it down in a short readme. Then pick the mixins you need (they help reduce custom code and keep the system reliable if internal calls change).
 
 - Is it just a simple REST-endpoint that runs a function ([ActionMixin](./plugins/action.md)) or a parser for a custom barcode format ([BarcodeMixin](./plugins/barcode.md))?
 - How does the user interact with the plugin? Is it a UI separate from the main InvenTree UI ([UrlsMixin](./plugins/urls.md)), does it need multiple pages with navigation-links ([NavigationMixin](./plugins/navigation.md)).
@@ -53,7 +53,7 @@ from plugin.mixins import APICallMixin, SettingsMixin, ScheduleMixin, BarcodeMix
 
 
 !!! tip "Package-Discovery can be tricky"
-    Most problems with packaging stem from problems with dicovery. [This guide](https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#automatic-discovery) by the PyPA contains a lot of information about discovery during packaging. Theses mechanisms generally apply to most discovery processes in InvenTree and the wider Django ecosystem.
+    Most problems with packaging stem from problems with discovery. [This guide](https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#automatic-discovery) by the PyPA contains a lot of information about discovery during packaging. These mechanisms generally apply to most discovery processes in InvenTree and the wider Django ecosystem.
 
 The recommended way of distribution is as a [PEP 561](https://peps.python.org/pep-0561/) compliant package. If you can use the official Package Index (PyPi - [official website](https://pypi.org/)) as a registry.
 Please follow PyPAs official [packaging guide](https://packaging.python.org/en/latest/tutorials/packaging-projects/) to ensure your package installs correctly suing InvenTrees install mechanisms.

docs/docs/extend/plugins/install.md

@@ -34,7 +34,7 @@ In certain container environments (such as docker), plugins are installed into a
 
 #### Builtin Plugins
 
-Builtin plugins ship in `src/InvenTree/plugin/builtin`. To achive full unit-testing for all mixins there are some sample implementations in `src/InvenTree/plugin/samples`.
+Builtin plugins ship in `src/InvenTree/plugin/builtin`. To achieve full unit-testing for all mixins there are some sample implementations in `src/InvenTree/plugin/samples`.
 
 !!! success "Builtin Plugins"
     Builtin plugins are always enabled, as they are required for core InvenTree functionality

docs/docs/extend/plugins/settings.md

@@ -77,4 +77,4 @@ This mixin defines the helper functions `plugin.get_setting` and `plugin.set_set
 api_url = self.get_setting('API_URL', cache = False)
 self.set_setting('API_URL', 'some value')
 ```
-`get_setting` has an additional parameter which lets control if the value is taken directly from the database or from the cache. If it is left away `False` ist the default that means the value is taken directly from the database.
+`get_setting` has an additional parameter which lets control if the value is taken directly from the database or from the cache. If it is left away `False` is the default that means the value is taken directly from the database.

docs/docs/extend/plugins/tags.md

@@ -4,7 +4,7 @@ title: Item Tags
 
 ## Tags
 
-Several models in InvenTree can be tagged with arbitrary tags. Tags are useful for grouping items together. This can be used to mark items with a plugin or to group items together for a particular theme. Tags are meant to be used by programms and are not visible to the end user.
+Several models in InvenTree can be tagged with arbitrary tags. Tags are useful for grouping items together. This can be used to mark items with a plugin or to group items together for a particular theme. Tags are meant to be used by programs and are not visible to the end user.
 Tags are shared between all models that can be tagged.
 
 The following models can be tagged:
@@ -52,7 +52,7 @@ Part.objects.filter(tags__name__in=["Tag1", "Tag 2"]).distinct()
 
 For models which provide tags, access is also provided via the API. The tags are exposed via the detail endpoint for the models starting from version 111.
 
-Tags can be cached via PATCH or POST requests. The tags are provided as a json formatted list of strings. The tags are note case sensitive and must be unique across the instance - else the exsisting tag gets assigned. The tags are not sorted and the order is not guaranteed.
+Tags can be cached via PATCH or POST requests. The tags are provided as a json formatted list of strings. The tags are note case sensitive and must be unique across the instance - else the existing tag gets assigned. The tags are not sorted and the order is not guaranteed.
 
 ```json
 {

docs/docs/extend/plugins/validation.md

@@ -16,7 +16,7 @@ Any of the methods described below can be implemented in a custom plugin to prov
 
 ### Part Name
 
-By default, part names are not subject to any particular naming conventions or requirements. However if custom validation is required, the `validate_part_name` method can be implement to ensure that a part name conforms to a required convention.
+By default, part names are not subject to any particular naming conventions or requirements. However if custom validation is required, the `validate_part_name` method can be implemented to ensure that a part name conforms to a required convention.
 
 If the custom method determines that the part name is *objectionable*, it should throw a `ValidationError` which will be handled upstream by parent calling methods.
 

docs/docs/faq.md

@@ -6,7 +6,7 @@ title: FAQ
 
 Below is a list of frequently asked questions. If you are having issues with InvenTree please consult this list first!
 
-## Installation Isues
+## Installation Issues
 
 ### Installing on Windows
 
@@ -68,7 +68,7 @@ For more information, refer to the installation guides:
 - [Bare Metal Installation](./start/install.md#updating-inventree)
 
 !!! warning "Invoke Update"
-    You must ensure that the `invoke update` command is perfomed *every time* you update InvenTree
+    You must ensure that the `invoke update` command is performed *every time* you update InvenTree
 
 ### Feature *x* does not work after update
 
@@ -118,7 +118,7 @@ It means that the user running the InvenTree server does not have permission to
 
 Ensure that the user running the InvenTree server has permission to create the required directories. For example, if running the server as the `inventree` user, ensure that the `inventree` user has permission to create the required directories.
 
-If you are using Docker to run the InvenTree server, ensure that the user that runs the docker deamon has permission to create the required directories in the volume.
+If you are using Docker to run the InvenTree server, ensure that the user that runs the docker daemon has permission to create the required directories in the volume.
 
 ### Failed to mount local volume
 

docs/docs/hooks.py

@@ -84,8 +84,8 @@ def fetch_rtd_versions():
     print("Discovered the following versions:")
     print(versions)
 
-    with open(output_filename, 'w') as fo:
-        json.dump(versions, fo, indent=2)
+    with open(output_filename, 'w') as file:
+        json.dump(versions, file, indent=2)
 
 
 def get_release_data():

docs/docs/order/company.md

@@ -54,7 +54,7 @@ To access the customer page, click on the <span class="badge inventree nav main"
 
 ### Add Customer
 
-Once the customer page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Customer</span> button: the "Create new Customer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
+Once the customer page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Customer</span> button: the "Create new Customer" form opens. Fill-in the manufacturer information (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
 
 ## Manufacturers
 
@@ -71,7 +71,7 @@ To access the list of manufacturers , click on the <span class="badge inventree
 
 ### Add Manufacturer
 
-Once the manufacturer page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Manufacturer</span> button: the "Create new Manufacturer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
+Once the manufacturer page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Manufacturer</span> button: the "Create new Manufacturer" form opens. Fill-in the manufacturer information (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
 
 !!! info "Manufacturer vs Supplier"
 	In the case the manufacturer sells directly to customers, you may want to enable the checkbox `is supplier` before submitting the form (you can also enable it later on). Purchase orders rely exclusively on [supplier parts](#supplier-parts), therefore the manufacturer will need to be set as a supplier too.
@@ -123,7 +123,7 @@ To access the supplier page, click on the <span class="badge inventree nav main"
 
 ### Add Supplier
 
-Once the supplier page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Supplier</span> button: the "Create new Supplier" form opens. Fill-in the supplier informations (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
+Once the supplier page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Supplier</span> button: the "Create new Supplier" form opens. Fill-in the supplier information (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
 
 !!! info "Supplier vs Manufacturer"
 	In the case the supplier is a manufacturer who sells directly to customers, you may want to enable the checkbox `is manufacturer` before submitting the form (you can also enable it later on).

docs/docs/order/return_order.md

@@ -4,7 +4,7 @@ title: Return Order
 
 ## Return Orders
 
-Return Orders allow stock items (which have been sold or allocted to a customer) to be to be returned into stock, typically for the purpose of repair or refund.
+Return Orders allow stock items (which have been sold or allocated to a customer) to be to be returned into stock, typically for the purpose of repair or refund.
 
 !!! tip "An Order By Any Other Name"
     A Return Order may also be known as an [RMA](https://en.wikipedia.org/wiki/Return_merchandise_authorization)
@@ -73,7 +73,7 @@ The order can be assigned to a responsible *owner*, which is either a user or gr
 
 ## Return Order Detail
 
-Indvidual Return Orders can be viewed via the Return Order detail page:
+Individual Return Orders can be viewed via the Return Order detail page:
 
 {% with id="return-order-detail", url="order/return_order_detail.png", description="Return Order Detail" %}
 {% include "img.html" %}

docs/docs/part/create.md

@@ -36,7 +36,7 @@ If the *Create Initial Stock* setting is enabled, then an extra section is avail
 
 If this setting is enabled, the following elements are available in the form:
 
-{% with id="initial_stock", url="part/part_initial_stock.png", descript="Inital stock" %}
+{% with id="initial_stock", url="part/part_initial_stock.png", descript="Initial stock" %}
 {% include "img.html" %}
 {% endwith %}
 

docs/docs/part/notification.md

@@ -71,7 +71,7 @@ If a user is subscribed to a particular part, it will be indicated as shown belo
 {% include 'img.html' %}
 {% endwith %}
 
-If the user is not subscibed, the subscription icon is greyed out, as shown here:
+If the user is not subscribed, the subscription icon is greyed out, as shown here:
 
 {% with id="part_sub_off", url="part/part_subscribe_off.png", description="Subscribe" %}
 {% include 'img.html' %}

docs/docs/part/part.md

@@ -4,7 +4,7 @@ title: Parts
 
 ## Part
 
-The *Part* is the core element of the InvenTree ecosystem. A Part object is the archetype of any stock item in your inventory. Parts are arranged in heirarchical categories which are used to organise and filter parts by function.
+The *Part* is the core element of the InvenTree ecosystem. A Part object is the archetype of any stock item in your inventory. Parts are arranged in hierarchical categories which are used to organise and filter parts by function.
 
 ## Part Category
 
@@ -132,7 +132,7 @@ In the web interface, part images can be uploaded directly from the [part view](
 
 #### API
 
-Image upload is supported via the [InvenTree API](../api/api.md), allowing images to be associated with parts programatically. Further, this means that the [Python interface](../api/python/python.md) also supports image upload.
+Image upload is supported via the [InvenTree API](../api/api.md), allowing images to be associated with parts programmatically. Further, this means that the [Python interface](../api/python/python.md) also supports image upload.
 
 #### Mobile App
 

docs/docs/part/pricing.md

@@ -160,7 +160,7 @@ Pricing data is cached in the [default currency](#default-currency), which ensur
 
 #### Data Updates
 
-The pricing data caching is intented to occur *automatically*, and generally be up-to-date without user interaction. Pricing data is re-calculated and cached by the [background worker](../settings/tasks.md) in the following ways:
+The pricing data caching is intended to occur *automatically*, and generally be up-to-date without user interaction. Pricing data is re-calculated and cached by the [background worker](../settings/tasks.md) in the following ways:
 
 - **Automatically** - If the underlying pricing data changes, part pricing is scheduled to be updated
 - **Periodically** - A daily task ensures that any outdated or missing pricing is kept updated

docs/docs/part/trackable.md

@@ -21,7 +21,7 @@ For faster input there are several ways to define the wanted serial numbers(SN):
 | --- | --- | --- | --- |
 |  | `1` | `[1]` | single SN |
 | , | `1,3,5` | `[1, 3, 5]` | list of SNs |
-| - | `1-5` | `[1, 2, 3, 4, 5]` | strech of SN |
+| - | `1-5` | `[1, 2, 3, 4, 5]` | stretch of SN |
 | ~ | `~` (next SN is 8) | `[8]` | represents the next SN |
 | `<start>`+ | `4+` (with 3 numbers needed) | `[4, 5, 6]` | all needed SNs from `<start>` |
 | `<start>`+`<length>` | `2+2` | `[2, 3, 4]` | `<length>` SNs added to `<start>` |

docs/docs/part/views.md

@@ -154,7 +154,7 @@ This feature can be enabled or disabled in the global part settings:
 
 ### Attachments
 
-The *Part Attachments* tab displays file attachments associated with the selected *Part*. Multiple file attachements (such as datasheets) can be uploaded for each *Part*.
+The *Part Attachments* tab displays file attachments associated with the selected *Part*. Multiple file attachments (such as datasheets) can be uploaded for each *Part*.
 
 ### Notes
 

docs/docs/releases/0.1.6.md

@@ -4,7 +4,7 @@ title: Release 0.1.6
 
 ## Release 0.1.6
 
-[Release 0.1.6](https://github.com/inventree/InvenTree/releases/tag/0.1.6) (Febuary 2021) provides a number of major new features and improvements, as well as some crucial bug fixes:
+[Release 0.1.6](https://github.com/inventree/InvenTree/releases/tag/0.1.6) (February 2021) provides a number of major new features and improvements, as well as some crucial bug fixes:
 
 ## New Features
 
@@ -49,4 +49,4 @@ Refer to the [BOM documentation](../build/bom.md) for further information.
 | [#1289](https://github.com/inventree/InvenTree/pull/1289) | Fixes display bug when a part "units" field is empty |
 | [#1290](https://github.com/inventree/InvenTree/pull/1290) | Fixes CSS issues with long error messages in modal forms |
 | [#1294](https://github.com/inventree/InvenTree/pull/1294) | Allows access to static files without being logged in |
-| [#1320](https://github.com/inventree/InvenTree/pull/1320) | Fixes "Used In" display for parts that are referenced in inerited BOMs |
+| [#1320](https://github.com/inventree/InvenTree/pull/1320) | Fixes "Used In" display for parts that are referenced in inherited BOMs |

docs/docs/releases/0.1.8.md

@@ -35,7 +35,7 @@ title: Release 0.1.8
 
 | PR | Description |
 | --- | --- |
-| [#1407](https://github.com/inventree/InvenTree/pull/1407) | Fixes unncessary column requirement when importing BOM |
+| [#1407](https://github.com/inventree/InvenTree/pull/1407) | Fixes unnecessary column requirement when importing BOM |
 | [#1430](https://github.com/inventree/InvenTree/pull/1430) | Fixes error thrown when migrating from very old data set |
 | [#1441](https://github.com/inventree/InvenTree/pull/1441) | Fixes template rendering error if git not available on system path |
 | [#1446](https://github.com/inventree/InvenTree/pull/1446) | Fixes bug exporting BOM to YAML format |

docs/docs/releases/0.2.2.md

@@ -18,7 +18,7 @@ title: Release 0.2.2
 
 ### Location Display
 
-[#1493](https://github.com/inventree/InvenTree/pull/1493) greatly improves the display of sublocations within a given location. Additonally, multiple sublocations can be selected (via checkboxes) allowing for printing of multiple StockLocation labels at once.
+[#1493](https://github.com/inventree/InvenTree/pull/1493) greatly improves the display of sublocations within a given location. Additionally, multiple sublocations can be selected (via checkboxes) allowing for printing of multiple StockLocation labels at once.
 
 ### Category Display
 
@@ -67,7 +67,7 @@ For more information refer to the [pricing documentation](../part/pricing.md).
 | [#1489](https://github.com/inventree/InvenTree/pull/1489) | Fixes bug which prevented customer assigned stock items from being returned to stock |
 | [#1525](https://github.com/inventree/InvenTree/pull/1525) | Fixes bug which referenced `MPN` field instead of `SKU` field
 | [#1523](https://github.com/inventree/InvenTree/pull/1523) | Fixes bug in part API filtering |
-| [#1535](https://github.com/inventree/InvenTree/pull/1535) | Fixes issues with part price break calulation |
+| [#1535](https://github.com/inventree/InvenTree/pull/1535) | Fixes issues with part price break calculation |
 | [#1544](https://github.com/inventree/InvenTree/pull/1544) | Fix invoke bug in tasks.py |
 | [#1558](https://github.com/inventree/InvenTree/pull/1558) | Fixes calendar rendering bug |
 | [#1567](https://github.com/inventree/InvenTree/pull/1567) | Fixes logout screen redirect loop |

docs/docs/releases/0.6.0.md

@@ -28,7 +28,7 @@ The results will be released in a few weeks in [GitHub Discussions](https://gith
 
 ### Build Order Allocation
 
-PR [#2094](https://github.com/inventree/InvenTree/pull/2094) represents a significant improvement to the worflow for allocating stock items against a build order. A new API endpoint has been created allowing stock items to be allocated against builds, with dynamic validation and feedback of error messages.
+PR [#2094](https://github.com/inventree/InvenTree/pull/2094) represents a significant improvement to the workflow for allocating stock items against a build order. A new API endpoint has been created allowing stock items to be allocated against builds, with dynamic validation and feedback of error messages.
 
 Additionally the workflow and UX has been simplified, allowing greater efficiency of stock allocation against a build order.
 

docs/docs/releases/0.6.2.md

@@ -12,7 +12,7 @@ For a comprehensive list of changes associated with this release, refer to the [
 
 | Pull Request | Description |
 | --- | --- |
-| [#2717](https://github.com/inventree/InvenTree/pull/2717) | Fixes bug which occured when empty serial number strings were supplied |
+| [#2717](https://github.com/inventree/InvenTree/pull/2717) | Fixes bug which occurred when empty serial number strings were supplied |
 | [#2720](https://github.com/inventree/InvenTree/pull/2720) | Fixes bug which prevented barcode scanning from working |
-| [#2721](https://github.com/inventree/InvenTree/pull/2721) | Fixes bug which occured when an arbitrarily large serial number was supplied |
+| [#2721](https://github.com/inventree/InvenTree/pull/2721) | Fixes bug which occurred when an arbitrarily large serial number was supplied |
 | [#2736](https://github.com/inventree/InvenTree/pull/2736) | Fixes incorrect behaviour when a PartCategory or StockLocation is deleted |

docs/docs/report/context_variables.md

@@ -89,8 +89,8 @@ Each part object has access to a lot of context variables about the part. The fo
 | creation_date | Date that this part was added to the database
 | creation_user | User who added this part to the database
 | responsible | User who is responsible for this part (optional)
-| starred | Wether the part is starred or not |
-| disabled | Wether the part is disabled or not |
+| starred | Whether the part is starred or not |
+| disabled | Whether the part is disabled or not |
 | total_stock | The total amount in stock |
 | quantity_being_built | The amount being built |
 | required_build_order_quantity | The amount required for build orders |
@@ -98,7 +98,7 @@ Each part object has access to a lot of context variables about the part. The fo
 | build_order_allocations | Query set with all build order allocations for that part |
 | required_sales_order_quantity | The amount required for sales orders |
 | allocated_sales_order_quantity | The amount allocated for sales orders |
-| available | Wether the part is available or not |
+| available | Whether the part is available or not |
 | on_order | The amount that are on order |
 | required | The total amount required for build orders and sales orders |
 | allocated | The total amount allocated for build orders and sales orders |
@@ -197,7 +197,7 @@ Each part object has access to a lot of context variables about the part. The fo
 | pretty_name | The IPN, supplier name, supplier SKU and (if not null) manufacturer string joined by `|`. Ex. `P00037 | Company | 000021` |
 | unit_pricing | The price for one unit. |
 | price_breaks | Return the associated price breaks in the correct order |
-| has_price_breaks | Wether this [SupplierPart](./context_variables.md#supplierpart) has price breaks |
+| has_price_breaks | Whether this [SupplierPart](./context_variables.md#supplierpart) has price breaks |
 | manufacturer_string | Format a MPN string for this [SupplierPart](./context_variables.md#supplierpart). Concatenates manufacture name and part number. |
 
 ### Manufacturers
@@ -232,7 +232,7 @@ A [Sales Order](../order/sales_order.md) object has the following context variab
 
 #### Return Order
 
-A [Return Order](../order/return_order.md) object has the following context variables avaiable.
+A [Return Order](../order/return_order.md) object has the following context variables available.
 
 | Variable | Description |
 | --- | --- |

docs/docs/report/labels.md

@@ -17,7 +17,7 @@ Label templates are written using a mixture of [HTML](https://www.w3schools.com/
 
 A label template is a single `.html` file which is uploaded to the InvenTree server by the user.
 
-Below is a reasonably simple example of a label template which demostrates much of the available functionality. The template code shown below will produce the following label:
+Below is a reasonably simple example of a label template which demonstrates much of the available functionality. The template code shown below will produce the following label:
 
 {% with id="label_example", url="report/label_example.png", description="Example label" %}
 {% include 'img.html' %}

docs/docs/report/report.md

@@ -168,7 +168,7 @@ Report templates are created (and edited) via the [admin interface](../settings/
     Only users with staff access can upload or edit report template files.
 
 !!! info "Editing Reports"
-    Existing reports can be edited from the admin interface, in the same location as described above. To change the contents of the template, re-upload a template file, to overrie the existing template data.
+    Existing reports can be edited from the admin interface, in the same location as described above. To change the contents of the template, re-upload a template file, to override the existing template data.
 
 ### Name and Description
 

docs/docs/settings/MFA.md

@@ -6,7 +6,7 @@ title: InvenTree Multi Factor Authentication
 
  InvenTree gives the option to use TOTP or statically generated backup tokens as an additional factor to password or SSO authentication. This is a widely adopted security feature on enterprise web services. We highly encourage to enable it if you expose your instance to the public internet.
 
-As TOTP is an [open standard](https://datatracker.ietf.org/doc/html/rfc6238) there are a lot of different ways to hold your key and generate the time based tokens needed for authentication. That ranges from physical devices to password managers and mobile apps. We do not advertise any method but recommend to keep password and token generator seperate from each other.
+As TOTP is an [open standard](https://datatracker.ietf.org/doc/html/rfc6238) there are a lot of different ways to hold your key and generate the time based tokens needed for authentication. That ranges from physical devices to password managers and mobile apps. We do not advertise any method but recommend to keep password and token generator separate from each other.
 
 ### Configuration
 
@@ -16,4 +16,4 @@ To make MFA mandatory for all users:
 
 ### Security Consideration
 
-A user can lock themself out if they lose access to both the device with their TOTP app and their backup tokens. An admin can delete their tokens from the admin pages (they exist under the 'TOTP devices' / 'static devices' models) . This should be a last resort and only done by people knowledgeable about the [admin pages](../settings/admin.md) as changes there might circumvent InvneTrees buisness and security logic.
+A user can lock themself out if they lose access to both the device with their TOTP app and their backup tokens. An admin can delete their tokens from the admin pages (they exist under the 'TOTP devices' / 'static devices' models) . This should be a last resort and only done by people knowledgeable about the [admin pages](../settings/admin.md) as changes there might circumvent InvneTrees business and security logic.

docs/docs/settings/admin.md

@@ -17,7 +17,7 @@ To access the admin interface, select the "Admin" option from the drop-down user
 
 
 !!! info "Staff Only"
-    Only users with staff acccess will be able to see the "Admin" option
+    Only users with staff access will be able to see the "Admin" option
 
 An adminstation panel will be presented as shown below:
 
@@ -26,7 +26,7 @@ An adminstation panel will be presented as shown below:
 {% endwith %}
 
 !!! info "Admin URL"
-    To directly access the admin iterface, append /admin/ to the InvenTree site URL - e.g. http://localhost:8000/admin/
+    To directly access the admin interface, append /admin/ to the InvenTree site URL - e.g. http://localhost:8000/admin/
 
 ### View Database Objects
 
@@ -49,7 +49,7 @@ Some admin views support filtering of results against specified criteria. For ex
 
 ### Edit Database Objects
 
-Individual database objects can be edited directly in the admin interface. The image below shows an exmple of editing a Part object:
+Individual database objects can be edited directly in the admin interface. The image below shows an example of editing a Part object:
 
 {% with id="edit_part", url="admin/edit_part.png", description="Edit Part object" %}
 {% include 'img.html' %}

docs/docs/settings/global.md

@@ -39,10 +39,10 @@ Change how logins, password-forgot, signups are handled.
 | Enable SSO registration | Boolean | Enable self-registration for users via SSO on the login-pages | False |
 | Enable password forgot | Boolean | Enable password forgot function on the login-pages.<br><br>This will let users reset their passwords on their own. For this feature to work you need to configure E-mail | True |
 | E-Mail required | Boolean | Require user to supply e-mail on signup.<br><br>Without a way (e-mail) to contact the user notifications and security features might not work! | False |
-| Enforce MFA | Boolean | Users must use multifactor security.<br><br>This forces each user to setup MFA and use it on each autentication | False |
+| Enforce MFA | Boolean | Users must use multifactor security.<br><br>This forces each user to setup MFA and use it on each authentication | False |
 | Mail twice | Boolean | On signup ask users twice for their mail | False |
 | Password twice | Boolean | On signup ask users twice for their password | True |
-| Auto-fill SSO users | Boolean | Automatically fill out user-details from SSO account-data.<br><br>If this feature is enabled the user is only asked for their username, first- and surname if those values can not be gathered from their SSO profile. This might lead to unwanted usernames bleading over. | True |
+| Auto-fill SSO users | Boolean | Automatically fill out user-details from SSO account-data.<br><br>If this feature is enabled the user is only asked for their username, first- and surname if those values can not be gathered from their SSO profile. This might lead to unwanted usernames bleeding over. | True |
 | Allowed domains | String | Restrict signup to certain domains (comma-separated, starting with @) |  |
 
 

docs/docs/settings/import.md

@@ -51,7 +51,7 @@ If you wish for a new database entry to be created for a particular data row, th
 
 #### Non-Empty ID
 
-If the `id` field in a given data row is *not* empty, then InvenTree inteprets that particular row as an *existing* row to override / update.
+If the `id` field in a given data row is *not* empty, then InvenTree interprets that particular row as an *existing* row to override / update.
 
 In this case, InvenTree will search the database for an entry with the matching `id`. If a matching entry is found, then the entry is updated with the provided data.
 

docs/docs/settings/permissions.md

@@ -7,7 +7,7 @@ title: User Permissions
 InvenTree provides access control to various features and data, by assigning each *user* to one (or more) *groups* which have multiple *roles* assigned.
 
 !!! info "Superuser"
-    The superuser account is afforded *all* permissions across an InvenTree intallation. This includes the admin interface, web interface, and API.
+    The superuser account is afforded *all* permissions across an InvenTree installation. This includes the admin interface, web interface, and API.
 
 ### User
 

docs/docs/start/config.md

@@ -40,7 +40,7 @@ The InvenTree server tries to locate the `config.yaml` configuration file on sta
 The configuration file *template* can be found on [GitHub](https://github.com/inventree/InvenTree/blob/master/InvenTree/config_template.yaml)
 
 !!! info "Template File"
-    The default configuration file (as defined by the template linked above) will be copied to the specifed configuration file location on first run, if a configuration file is not found in that location.
+    The default configuration file (as defined by the template linked above) will be copied to the specified configuration file location on first run, if a configuration file is not found in that location.
 
 !!! tip "Restart Server"
     The contents of the configuration file are read when the InevnTree server first launches. If any changes are made to the configuration file, ensure that the server is restarted, so that the changes can be made operational.

docs/docs/start/development.md

@@ -40,7 +40,7 @@ To enable access to the InvenTree server from other computers on a local network
 
 ## Background Worker
 
-The backgroun task manager must also be started. The InvenTree server is already running in the foreground, so open a *new shell window* to start the server.
+The background task manager must also be started. The InvenTree server is already running in the foreground, so open a *new shell window* to start the server.
 
 ### Activate Virtual Environment
 

docs/docs/start/docker_dev.md

@@ -161,7 +161,7 @@ docker compose run inventree-dev-server invoke update
 
 ### Docker Image Updates
 
-Occassionally, the docker image itself may receive some updates. In these cases, it may be required that the image is rebuilt. To perform a complete rebuild of the InvenTree development image from local source, run the following command:
+Occasionally, the docker image itself may receive some updates. In these cases, it may be required that the image is rebuilt. To perform a complete rebuild of the InvenTree development image from local source, run the following command:
 
 ```
 docker compose build --no-cache

docs/docs/start/docker_prod.md

@@ -151,7 +151,7 @@ If you are creating the initial database, you need to create an admin (superuser
 docker compose run inventree-server invoke superuser
 ```
 
-Alternatively, admin account details can be specifed in the `.env` file, removing the need for this manual step:
+Alternatively, admin account details can be specified in the `.env` file, removing the need for this manual step:
 
 | Variable | Description |
 | --- | --- |
@@ -203,7 +203,7 @@ docker compose pull
 This ensures that the InvenTree containers will be running the latest version of the InvenTree source code.
 
 !!! info "Tagged Version"
-    If you are targetting a particular "tagged" version of InvenTree, you may wish to edit the `INVENTREE_TAG` variable in the `.env` file before issuing the `docker compose pull` command
+    If you are targeting a particular "tagged" version of InvenTree, you may wish to edit the `INVENTREE_TAG` variable in the `.env` file before issuing the `docker compose pull` command
 
 ### Update Database
 

docs/docs/start/install.md

@@ -307,7 +307,7 @@ invoke update
 
 This command performs the following steps:
 
-* Ensure all rquired packages are installed and up to date
+* Ensure all required packages are installed and up to date
 * Perform required database schema changes
 * Run the user through any steps which require interaction
 * Collect any new or updated static files

docs/docs/start/installer.md

@@ -77,10 +77,10 @@ By default, InvenTree is served internally on port 6000 and then proxied via Ngi
 This only serves an HTTP version of InvenTree, to use HTTPS (recommended for production) or customise any further an additional config file should be used.
 
 #### Extra python packages
-Extra python packages can be installed by setting the enviroment variable `SETUP_EXTRA_PIP`.
+Extra python packages can be installed by setting the environment variable `SETUP_EXTRA_PIP`.
 
 #### Database Options
-The used database backend can be configured with enviroment variables (before the first setup) or in the config file after the installation. Check the [configuration section](./config.md#database-options) for more information.
+The used database backend can be configured with environment variables (before the first setup) or in the config file after the installation. Check the [configuration section](./config.md#database-options) for more information.
 
 ## Moving Data
 To change the data storage location, link the new location to `/opt/inventree/data`.

docs/docs/start/intro.md

@@ -81,7 +81,7 @@ Installing the required Python packages inside a virtual environment allows a lo
 You can read more about Python virtual environments [here](https://docs.python.org/3/tutorial/venv.html).
 
 !!! info "Virtual Environment"
-    The installation intstruction assume that a virtual environment is configured
+    The installation instruction assume that a virtual environment is configured
 
 `cd` into the InvenTree directory, and create a virtual environment with the following command:
 

docs/docs/start/migrate.md

@@ -43,7 +43,7 @@ This step ensures that the required database tables exist, and are at the correc
 
 ### Import Data
 
-The new database should now be correctly initialized with the correct table structures requried to import the data. Run the following command to load the databased dump file into the new database.
+The new database should now be correctly initialized with the correct table structures required to import the data. Run the following command to load the databased dump file into the new database.
 
 !!! warning "Empty Database"
     If the database is not *empty* (i.e. it contains data records) then the data import process will fail. If errors occur during the import process, run `invoke import-records` with the `-c` option to clear all existing data from the database.
@@ -85,7 +85,7 @@ Download the specific version of InvenTree you wish to update to.
 
 ### Run Update Process
 
-Run the update and migration script using `invoke update`. This ensures that the database schema and records are udpated in the correct order.
+Run the update and migration script using `invoke update`. This ensures that the database schema and records are updated in the correct order.
 
 ### Restart Server
 

docs/docs/stock/adjust.md

@@ -6,7 +6,7 @@ title: Stock Adjustments
 
 InvenTree provides simple yet powerful management of stock levels. Multiple stock adjustment options are available, and each type of adjustment is automatically tracked to maintain a complete stock history.
 
-Stock adjustements can be accessed in any stock items table using the "Stock Options" dropdown entries:
+Stock adjustments can be accessed in any stock items table using the "Stock Options" dropdown entries:
 
 {% with id="stock_options", url="stock/stock_options.png", description="Stock Options" %}
 {% include 'img.html' %}
@@ -52,8 +52,8 @@ The conditions for merging stock items are the following:
 
 - a stock item cannot be merged with itself
 - only stock items referring to the same part can be merged
-- supplier parts between all items have to match, unless user explicitely allows supplier parts to be different (see below)
-- stock status between all items have to match, unless user explicitely allows stock status to be different (see below).
+- supplier parts between all items have to match, unless user explicitly allows supplier parts to be different (see below)
+- stock status between all items have to match, unless user explicitly allows stock status to be different (see below).
 
 Moreover, if one of the item:
 
@@ -61,7 +61,7 @@ Moreover, if one of the item:
 - or is installed in another item
 - or contains other items
 - or is assigned to a customer
-- or is currenty in production
+- or is currently in production
 - or is serialized
 
 then the merge would not be possible.

docs/docs/stock/tracking.md

@@ -108,7 +108,7 @@ Any of the above patterns can be combined using multiple groups separated by the
 
 In the default implementation, InvenTree assumes that serial "numbers" are integer values in a simple incrementing sequence e.g. `{1, 2, 3, 4, 5, 6}`. When generating the *next* value for a serial number, the algorithm looks for the *most recent* serial number, and attempts to coerce that value into an integer, and then increment that value.
 
-While this approach is reasonably robust, it is definitely simplistic and is not expected to meet the requirements of every installation. For this reason, more complex serial number management is intented to be implemented using a custom plugin (see below).
+While this approach is reasonably robust, it is definitely simplistic and is not expected to meet the requirements of every installation. For this reason, more complex serial number management is intended to be implemented using a custom plugin (see below).
 
 #### Serial Number Errors