Update the documentation of jQuery.data to indicate what the function actually accepts for the 1st parameter.

Ouverte
#1,035 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
52/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
jquery
Domaine
documentation

Piste de recherche

Commencez par la page de documentation de jQuery.data et comparez ses signatures de paramètres avec src/data/var/acceptData.js, que l’issue identifie comme preuve des nœuds pris en charge. Mettez à jour la documentation afin que le premier paramètre reflète correctement le type Document accepté et clarifiez le comportement de l’objet mentionné si cela est confirmé. C’est terminé lorsque les signatures publiées correspondent aux entrées prises en charge.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

The documentation for jQuery.data gives the following signatures:

jQuery.data( element, key, value )
jQuery.data( element, key )
jQuery.data( element )

In all three the element parameter is typed as Element. However, jQuery does accept an element which is of type Document. Two pieces of evidence:

  1. In practice, I've used jQuery.data on Document objects for years, without any trouble.

  2. The data machinery calls on acceptData to detect whether a node is fit to be used as the first argument of the data function. acceptData's code and comments both explicitly consider that Document is a valid node.

It seems that JavaScript objects that do not have a numeric nodeType field can also be used with jQuery.data. I'm mentioning this for completeness. I've never used this capability.

Langage dominant
HTML
Étoiles
324
Forks
259
Merge moyen
1 j 30 min
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de jquery/api.jquery.com

Toutes les issues de jquery/api.jquery.com

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.