Skip to content

docs: añadir ejemplo de max_length al README - #14

Open
lomeliDev wants to merge 1 commit into
masterfrom
issue/11-docs-anadir-ejemplo-de-max-length-al-readme
Open

lomeliDev wants to merge 1 commit into
masterfrom
issue/11-docs-anadir-ejemplo-de-max-length-al-readme

Conversation

@lomeliDev

Copy link
Copy Markdown
Owner

Resumen

Añade al README un ejemplo corto y ejecutable de max_length, en la sección Quickstart, tal y como pide la Issue #11.

Archivos

  • README.md — un ejemplo assert slugify('Hello, world!', max_length=8) == 'hello-wo' en el bloque Python del Quickstart.

Cambio

El Quickstart ya mostraba algorithm='modern', backend y allow_unicode, pero no max_length. Se añade un ejemplo mínimo que demuestra el truncado:

# Truncate long slugs with max_length.
assert slugify('Hello, world!', max_length=8) == 'hello-wo'

Verificado contra la versión instalada (9.1.3): slugify('Hello, world!', max_length=8) devuelve 'hello-wo'.

Evidencia

Cambio de solo documentación: no modifica código de producción ni añade test, por lo que no puede ponerse rojo — no existe un test de regresión que distinguir porque no hay comportamiento en producción que cambie. El único criterio de la Issue es documental ("el README contiene max_length en un ejemplo ejecutable"), que se cumple de forma literal.

Puerta de calidad reproducida (workflow taller-ci.yml, que es el CI fork-safe que corre en PRs; matriz 3.11 y 3.12). Reproducida en Python 3.11.2 dentro de un entorno del propio worktree (.venv):

$ .venv/bin/flake8 --ignore=E501,F403,F401,E241,E225,E128 --exclude=legacy_reference.py slugify setup.py tests tools
# exit 0

$ .venv/bin/pycodestyle --ignore=E128,E261,E225,E501,W605 --exclude=legacy_reference.py slugify tests setup.py tools
# exit 0

$ .venv/bin/python -m pytest tests
# 133 passed, 5 skipped, 136 subtests passed

Python 3.12 no está instalado en esta máquina y no puede reproducirse aquí (exigiría descargar/instalar otra versión fuera del worktree); se declara no reproducida. No vi sintaxis de riesgo en el workflow (sin BigInt, sin ?., sin ??) y el cambio no toca código Python, por lo que no hay superficie para romper el job 3.12.

El diff se ciñe a los Archivos: de la Issue (README.md), sin lockfiles ni ficheros ajenos.

Relacionada con: #11

Add a short executable max_length example to the Quickstart section.

Closes-topic: #11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant