All: Modules in potential need of documentation

オープン
  • 何か問題がありますか？
#367 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
jquery
領域
documentation

調査の方向性

まず、issue に記載されているドキュメントのボイラープレートと既存の exclude グループの処理を、core モジュールを例として確認します。一覧にあるどのモジュールにドキュメントまたはデモが必要で、どれを除外すべきかを明確にします。判断が記録され、影響を受けるモジュールが意図したドキュメントメタデータを生成するか、一貫して非表示になることを完了条件とします。

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

説明

As I'm implementing the boilerplate for our library, I'm finding that I cannot produce a "docs" metadata field for some of our modules. Here are those we may (not) want to document/demo:

  • zoom
  • animationComplete
  • navigation/base (do we even need it anymore? https://github.com/jquery/jquery-mobile/issues/7489)
  • navigation/path (needs demos - maybe?)
  • widgets/controlgroup.backcompat (needs if ( $.mobileBackcompat ))
  • slider tooltip API (option popupEnabled and showValue)
  • textarea autogrow has no demo
  • $.mobile.iosorientationfixEnabled needs to be documented in global options (also, demo?)
  • accordion - docs and demos
  • support - do we want docs/demos?

Can we use the "exclude" group to hide modules in the DB? I've encountered

//>>group: exclude

For example, our core, which is merely a bundling of other modules, is labelled thus.

主要言語
HTML
スター
55
フォーク
57
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

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

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

似ている issue

Documentation の issue をもっと見る

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

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