Guide for templates based on specified requirements

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

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

評価

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

調査の方向性

The request concerns template design and the -t templates_dir option for generating Solidity documentation. Start by reviewing the existing template and command-option documentation, if present. Done means providing a guide that explains template customization and how to represent the requested filtering and formatting requirements.

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

説明

I need to generate docs for contracts with next requirements:

  1. All documented methods from base class should be inside derived class.
  2. All methods with keyword internal and private shouldn't be inside generated docs
  3. Function modifiers shouldn't be inside docs.

Is it possible? Should I use option -t templates_dir? Where can I find the guide of designing templates

主要言語
TypeScript
スター
460
フォーク
111
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 を短くまとめたダイジェスト。