Be smarter about example files

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

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

評価

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

調査の方向性

まず、出力ファイルを余分なものとしてマークするバリデーションを見つけ、ドキュメントのファイル名が兄弟ファイルとどのように比較されているかを確認します。m_connect.md と m_connect_example.cpp および m_foobar_example.cpp の例を使って、対応する .cpp ファイルは許可される一方で、対応しない example ファイルは引き続きマークされることを検証します。

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

説明

Right now we permit example files to be included as siblings to the docs. (e.g., connect.md references connect_example.cpp.) These files are considered extraneous by the tool. We should permit all .cpp files in the output directories as long as they are start with the same name as a documentation file. Example:

m_connect.md // the doc file
m_connect_example.cpp // example file for connect. OK - do not flag.
m_foobar_example.cpp // example for a dead API, perhaps? Bad - should be flagged.
主要言語
C++
スター
341
フォーク
45
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

adobe/hyde のほかの issue

adobe/hyde の issue をすべて見る

似ている issue

C++ の issue をもっと見る

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

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