2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-15 03:25:42 +00:00

Add module-level docstrings for each app

This commit is contained in:
Oliver Walters
2019-04-28 01:05:45 +10:00
parent b0487b33dc
commit aa04941bf1
6 changed files with 134 additions and 0 deletions

View File

@ -0,0 +1,5 @@
"""
The InvenTree module provides high-level management and functionality.
It provides a number of helper functions and generic classes which are used by InvenTree apps.
"""

View File

@ -0,0 +1,5 @@
"""
The Build module is responsible for managing "Build" transactions.
A Build consumes parts from stock to create new parts
"""

View File

@ -0,0 +1,8 @@
"""
The Company module is responsible for managing Company interactions.
A company can be either (or both):
- Supplier
- Customer
"""

View File

@ -0,0 +1,10 @@
"""
The Part module is responsible for Part management.
It includes models for:
- PartCategory
- Part
- SupplierPart
- BomItem
"""

View File

@ -0,0 +1,9 @@
"""
The Stock module is responsible for Stock management.
It includes models for:
- StockLocation
- StockItem
- StockItemTracking
"""