Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Missing Documentation - Inbuilt Plugins Behavior

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
javascript, python
領域
documentation

調査の方向性

Start with docs/user-guide/configuration.md and core/src/plugins.js, then inspect the linked implementation such as core/src/plugins/error.js to inventory built-in plugins and their behavior. Create a documentation page covering each plugin, including which features depend on it, and correct the !plugin-name typo.

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

説明

Background

When testing a PyScript application I noticed that when something was written to stderr, the application would append a div of class py-error to the document. With some digging I determined that this was part of the error plugin.

Problem

Other than mentioning that there are some inbuilt plugins, we do not go into any detail about what they are. Some of them are obviously, from context, related to features that are mentioned elsewhere in the docs such as py-editor, py-terminal, and even donkey is explained. But others, like deprecations-manager and codemirror have no explanation as to what they do. The only mention of error is that it can be disabled.

Location

The only mention of built-in plugins is under the "Plugins" section of configuration.md, where it links to plugin.js and makes an offhand mention that you can disable inbuilt plugin with an explanation point (e.g. !error).

Proposal

Create a page that goes through the plugins installed, and their behavior/purpose. Some of these plugins may be stub references that reference the actual feature pages, such as py-terminal, py-editor and donkey as separating what the feature does vs what the plugin does may be difficult, but I think having them documented as a) existing and b) essential for that feature to operate would at the very least prevent a help request from someone who is trying to use Terminal, wondering why it isn't working, only to find that they had disabled all inbuilt plugins.

Auxiliary Benefits

Documenting the inbuilt plugins will make it easier for developers to request improvements to the plugins, for example as an obvious improvement it might be better to configure the styling of the py-error class inside core.css rather than hard coding the values, allowing for easier customization of the behavior of the plugin without the need to write a custom implementation.

Nits

... using the !pugin-name convention...

Pretty sure that should be !plugin-name.

主要言語
Python
スター
17
フォーク
20
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

pyscript/docs のほかの issue

pyscript/docs の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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