Skip to content

docs: documentar el parámetro stopwords en el README - #13

Open
lomeliDev wants to merge 1 commit into
masterfrom
issue/12-docs-documentar-el-parametro-stopwords-en-el-readme
Open

lomeliDev wants to merge 1 commit into
masterfrom
issue/12-docs-documentar-el-parametro-stopwords-en-el-readme

Conversation

@lomeliDev

Copy link
Copy Markdown
Owner

Resumen

Documenta stopwords en el ejemplo Python del README, mostrando cómo excluir palabras completas del slug.

Issue relacionada: #12

Causa raíz y alcance

El README describía stopwords en la referencia de opciones y mostraba el uso en CLI, pero no incluía un ejemplo Python con stopwords=. El cambio mínimo añade ese ejemplo en README.md, el único archivo indicado por la Issue.

Evidencia

  • Este cambio es exclusivamente documental; no puede ponerse en rojo porque no modifica código ni comportamiento ejecutable.
  • Comprobación manual del ejemplo:
    • Comando: python3 - <<'PY'\nfrom slugify import slugify\nprint(slugify('The quick brown fox jumps over the lazy dog', stopwords=('the', 'over')))\nPY
    • Salida: quick-brown-fox-jumps-lazy-dog
  • Suite completa solicitada: python3 -m pytest tests — no reproducible completamente en este entorno: 20 failed, 112 passed, 1 skipped, por dependencias no instaladas (text_unidecode/unidecode).
  • Linters del workflow del taller: flake8 ... y pycodestyle ... — no reproducibles porque ambos comandos no están instalados.
  • El workflow taller-ci.yml usa Python 3.11 y 3.12; sólo está disponible Python 3.11 localmente. La matriz upstream declara 3.10–3.14 y PyPy 3.11; no se reprodujeron las demás versiones.
  • El diff se limita a README.md, sin lockfiles, archivos locales, secretos ni artefactos generados.
  • Sonda de choque contra origin/master: SIN CHOQUE.

Commit

3511293

Co-authored-by: CommandCodeBot <noreply@commandcode.ai>
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