Support custom errors

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

@frangio がすでに取り組んでいます。

2021年12月10日 から。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
solidity
領域
documentation

調査の方向性

Start by reproducing the Markdown report with the linked BalanceSheet contract and inspect the report-generation and custom-error configuration paths. Done means custom errors can be configured and then appear in the generated Markdown output.

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

説明

Custom errors cannot be configured to be included in the Markdown report.

When I run solidity-docgen over a contract with lots of custom errors (such as the BalanceSheet), the custom errors are not included in the output.

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

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

OpenZeppelin/solidity-docgen のほかの issue

OpenZeppelin/solidity-docgen の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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