docs: add full documentation for all functions in tienda/views.py
Agent-Logs-Url: https://github.com/dsaub/proyecto-final/sessions/49df17c8-213a-4e23-adfe-465a0104f6a3 Co-authored-by: dsaub <54474838+dsaub@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
47ea00c822
commit
ed92991872
@@ -0,0 +1,30 @@
|
||||
# `_build_stock_issue_message`
|
||||
|
||||
**Archivo:** `tienda/views.py`
|
||||
**Tipo:** Función auxiliar privada
|
||||
|
||||
## Descripción
|
||||
|
||||
Construye el mensaje de error legible por el usuario cuando hay un conflicto de stock para un ítem del carrito.
|
||||
|
||||
## Firma
|
||||
|
||||
```python
|
||||
def _build_stock_issue_message(issue: dict) -> str:
|
||||
```
|
||||
|
||||
## Parámetros
|
||||
|
||||
| Nombre | Tipo | Descripción |
|
||||
|---------|--------|----------------------------------------------------------------------------------|
|
||||
| `issue` | `dict` | Diccionario con las claves `product_name`, `available` y `requested`. |
|
||||
|
||||
## Retorno
|
||||
|
||||
Cadena con el mensaje de error, por ejemplo:
|
||||
|
||||
> `No hay stock suficiente de 'Camiseta azul'. Disponible: 3, solicitado: 5.`
|
||||
|
||||
## Uso interno
|
||||
|
||||
Llamada en [`_create_stock_reservation_for_cart`](./_create_stock_reservation_for_cart.md), [`create_order_from_cart`](./create_order_from_cart.md), [`create_checkout_session`](./create_checkout_session.md) y [`create_paypal_payment`](./create_paypal_payment.md).
|
||||
Reference in New Issue
Block a user