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>
2026-04-09 10:35:28 +00:00
parent 47ea00c822
commit ed92991872
66 changed files with 2580 additions and 0 deletions
@@ -0,0 +1,28 @@
+# `logout`
+
+**Archivo:** `tienda/views.py`  
+**URL:** `/tienda/logout/`  
+**Tipo:** Vista pública
+
+## Descripción
+
+Cierra la sesión del usuario autenticado actual. Registra el evento de cierre de sesión en el logger de auditoría y redirige al catálogo con un mensaje de confirmación.
+
+## Firma
+
+```python
+def logout(request: HttpRequest):
+```
+
+## Parámetros
+
+| Nombre    | Tipo          | Descripción           |
+|-----------|---------------|-----------------------|
+| `request` | `HttpRequest` | Petición HTTP de Django. |
+
+## Redirecciones
+
+Siempre redirige a `index` tras el cierre de sesión.
+
+> [!NOTE]
+> El evento se registra con `user_id`, `email` e IP del cliente en el logger `tienda.audit`, independientemente de si había un usuario autenticado o no.