Improve documentation for `converters`

オープン
#1,090 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
50/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
jquery
領域
documentation

調査の方向性

issue にリンクされた jQuery.ajax のドキュメントを開き、converters セクションを見つけてください。"text html": true が何をするのかを明確にし、示されている $.ajaxSetup の例を dataType: 'json'; で拡張してください。要求された2つのドキュメント変更が正確に反映されたら完了です。

索引モデルが issue の本文から書いたものです。

説明

DOC

There is no description what "text html": true does

Also extend the example:

$.ajaxSetup({
  contents: {
    mycustomtype: /mycustomtype/
  },
  converters: {
    "mycustomtype json": function( result ) {
      // Do stuff
      return newresult;
    }
  }
});

by adding dataType: 'json', to be explicit that callback expects json format

Current documentation lead to missread. As result I get this

主要言語
HTML
スター
324
フォーク
259
平均マージ
1日 30分
マージ済み PR(30日)
1

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

jquery/api.jquery.com のほかの issue

jquery/api.jquery.com の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。