docs(core): READMEs and TSDoc examples use removed APIs

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

メンテナーはふだん 1 日以内に返信

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

評価

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

調査の方向性

packages/core/README.md、packages/asset/README.md、modules/ecs/README.mdの例を読み、packages/core/src/application/nanoforge-application.tsとnanoforge-client.tsにある現在のAPIと比較してください。スニペットを更新して、issueに記載された名前とパターンを使うようにし、古くなったasset-managerの例を削除して、アロー関数のルールに従ってください。例が現在のAPIを使い、削除された名前を表示しなくなれば完了です。

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

説明

documentation modules:ecs packages:asset packages:core
What is the type of issue?

Documentation is incorrect, Example code is not working

What is the issue?

The examples use IRunOptions / IRunClientOptions (renamed to RunOptions / ClientRunOptions), @nanoforge-dev/asset-manager and app.useAssetManager (assets are now on ctx.assets), useGraphics(...), and __RESERVED_entityId (getIndexedZipper returns id). None of these names exist in src. They also use export async function, against the arrow-function rule.

Evidence:

import { type IRunOptions } from "@nanoforge-dev/common";
app.useAssetManager(assetManager);
for (const { __RESERVED_entityId, Position } of registry.getZipper([

Suggested fix: Rewrite the snippets against the current API (ClientRunOptions, app.use(...), getIndexedZipper([Position]) with id) and remove the asset-manager snippet.

Found during a code audit of main at be72076.

Where did you find it?
主要言語
TypeScript
スター
7
フォーク
2
平均マージ
1日 17時間
マージ済み PR（30日）
17

環境構築

はじめの一歩

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

NanoForge-dev/Engine のほかの issue

NanoForge-dev/Engine の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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