Repository navigation
Conversation
Add a short executable max_length example to the Quickstart section. Closes-topic: #11
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 ejemploassert slugify('Hello, world!', max_length=8) == 'hello-wo'en el bloque Python del Quickstart.Cambio
El Quickstart ya mostraba
algorithm='modern',backendyallow_unicode, pero nomax_length. Se añade un ejemplo mínimo que demuestra el truncado: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_lengthen 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):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