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,39 @@
|
||||
# `search`
|
||||
|
||||
**Archivo:** `tienda/views.py`
|
||||
**URL:** `/tienda/buscar/`
|
||||
**Tipo:** Vista pública
|
||||
|
||||
## Descripción
|
||||
|
||||
Busca productos por nombre, descripción breve o descripción completa y devuelve los resultados. Si no se proporciona ningún término de búsqueda, se devuelve una lista vacía.
|
||||
|
||||
## Firma
|
||||
|
||||
```python
|
||||
def search(request: HttpRequest):
|
||||
```
|
||||
|
||||
## Parámetros
|
||||
|
||||
| Nombre | Tipo | Descripción |
|
||||
|-----------|---------------|-----------------------|
|
||||
| `request` | `HttpRequest` | Petición HTTP de Django. |
|
||||
|
||||
## Parámetros GET
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
|-----------|--------|------------------------------|
|
||||
| `q` | `str` | Término de búsqueda. |
|
||||
|
||||
## Contexto del template
|
||||
|
||||
| Variable | Tipo | Descripción |
|
||||
|--------------|-----------|----------------------------------------------------|
|
||||
| `products` | QuerySet o lista | Resultados de la búsqueda. |
|
||||
| `query` | `str` | Término de búsqueda utilizado. |
|
||||
| `categories` | QuerySet | Todas las categorías para el menú de navegación. |
|
||||
|
||||
## Template
|
||||
|
||||
`tienda/search.html`
|
||||
Reference in New Issue
Block a user