NVIDIA / NVIDIA/cuda-python

[BUG] Inner lists in `cuda.bindings` API reference are dropped

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

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

bug cuda.bindings documentation P1
主要言語
Cython
スター
3.4k
フォーク
329
平均マージ
1日 23時間
マージ済み PR(30日)
116

説明

Taking NVRTC's --gpu-architecture option as example:

  • This is the generated docs (by parsing Doxygen docstrings with an internal tool)
Image
  • This is the public docs (the list is too long, so I only show a portion of it)
Image
  • This is the docstring from nvrtc.h (also truncated):
 * The valid compiler options are:
 *
 *   - Compilation targets
 *     - \c --gpu-architecture=\<arch\> (\c -arch)
 * 
 *       Specify the name of the class of GPU architectures for which the
 *       input must be compiled.\n
 *       - Valid <c>\<arch\></c>s:
 *         - \c compute_50
 *         - \c compute_52
 *         - \c compute_53
 *         - \c compute_60
 *         - \c compute_61
 *         - \c compute_62
 *         - \c compute_70
 *         - \c compute_72
 *         - \c compute_75
 *         - \c compute_80
 *         - \c compute_86
 *         - \c compute_87
 *         - \c compute_89

We can see the inner lists are not parsed.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

調査の方向性

生成された API リファレンスを、公開ドキュメントおよび nvrtc.h の docstring に示されているネストされたリスト構造と比較します。内部の Doxygen 解析ツールを追跡して、ネストされたリストがどこで破棄されているかを特定し、その後、CUDA API リファレンスで内部リストが保持されていることを確認します。

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

評価

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

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

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