Mention of ‘timestamp’ in documentation for ‘cache’ parameter of ‘ajax’ is misleading

Abierto Apto para principiantes
#1,241 2 comentarios 0 reacciones 0 asignados Ver en GitHub

@Rinzwind ya está trabajando en esto.

Desde el 15/11/2023.

  • #1242 de @Rinzwind — abierto

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
62/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
jquery

Línea de trabajo

Comienza con la entrada de documentación del parámetro cache de ajax y compara su redacción con las líneas 9435 y 8501 referenciadas de dist/jquery.js. Actualiza la descripción para que se refiera al valor añadido como uid en lugar de como una marca de tiempo; la redacción engañosa ya no debería aparecer.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

The documentation for the ‘cache’ parameter of ‘ajax’ says:

It works by appending "_={timestamp}" to the GET parameters.

This seems a bit misleading. I interpreted it as a timestamp of when the request is sent. But the value after _= is actually taken from a counter:

https://github.com/jquery/jquery/blob/f79d5f1a337528940ab7029d4f8bbba72326f269/dist/jquery.js#L9435

The counter is only initialized using Date.now():

https://github.com/jquery/jquery/blob/f79d5f1a337528940ab7029d4f8bbba72326f269/dist/jquery.js#L8501

I got confused by that when analyzing nginx access logs and wondering why the ‘timestamps’ didn’t match up.

The documentation should probably just say that it works by appending "_={uid}".

Lenguaje dominante
HTML
Estrellas
324
Forks
259
Merge medio
1 d 30 min
PR fusionados (30 d)
1

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de jquery/api.jquery.com

Todos los issues de jquery/api.jquery.com

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.