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

Errors, missing code/links in Workers section

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

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

評価

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

調査の方向性

Start with the Workers documentation page at https://docs.pyscript.net/2025.3.1/user-guide/workers/ and inspect the Worker interactions and Common use case sections. Verify the broken PyScript.com link and identify missing code or unclear dependencies between examples. Done means the examples are complete or clearly cross-referenced, the link works or is replaced, and the worker startup patterns are understandable.

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

説明

In one place where workers are mentioned:

There are several pieces of code with code elements missing.
Also the two ways workers can be started are confusing because of this missing code.
Also the link to a working example is 404

The only problem with this is that people who are NOT Javascript experts may not be able to work out all the usecases that are legitimate from the code available. (I know I can't.)

  1. Missing link:
  • In this section of the page is a link:
The values passed between the main thread and the worker must be serializable. Try the example given above via [this project on PyScript.com](https://pyscript.com/@ntoll/tiny-silence/latest).
  • this link is 404
  1. In the Section Common use case the code refers to greeting which is defined in the previous section Worker interactions but not in this code. Its not clear which code should be carried forward from example to example and which is standalone. Ideally all the code for main and worker should (IMHO) be standalone and complete - or point to an example which works.

IMHO - It would be nice if the sections showed:

  • starting a worker from index.html
    • that does one job and has one function (from pyscript import workers)?
    • same but can be called multiple times with multiple functions (__export__ = ["fname1", "fname2"])?
    • some of which update the dom directly and some of which pass data back to main.
  • starting from python using Pyworker (from pyscript import PyWorker)
    • defining multiple functions that can be called,
    • setting a config so a package can be loaded,
    • some of which update the dom directly and some of which pass data back to main.
  • whatever is required for the donkey to:
    • send new code to the donkey for it to operate with,
    • see results like donkey's main use case - running code and seeing the results in a textarea,
    • see results where it can do the jobs defined for the previous two cases (sending data back).

IMHO this would make it easier for people to work out how to use workers in pyscript.
Any examples that could be generated for the docs would also be great and it would be nice if they followed the categories indicated above.
(I'd happily contribute a demo if I could work out how to make it ALL work.)

主要言語
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 を短くまとめたダイジェスト。