Docs refactor: use `#[cfg(doc)]`

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

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

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

2026年10月31日 から。

  • #2 @Sweesz による — オープン

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
活発
技術スタック
rust
領域
documentation

調査の方向性

まずライブラリ内で、#[allow(unused_imports)] が付けられたドキュメント専用のインポートを検索し、issue の例と比較します。一致するアノテーションを #[cfg(doc)] に置き換えます。これらのインポートがドキュメントのビルド時にのみ有効になれば作業は完了です。

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

説明

documentation good first issue help wanted refactor

A common problem is that the sample code in crate docs ofter needs access to more primitives than the actual source code does, RNG or KeyMaterial, etc. We have blocks like this sprinkled across the library:

// imports just for docs
#[allow(unused_imports)]
use crate::mlkem::MLKEMTrait;
#[allow(unused_imports)]
use crate::polynomial::Polynomial;

A better pattern would be:

// imports just for docs
#[cfg(doc)] use crate::mlkem::MLKEMTrait;
#[cfg(doc)] use crate::polynomial::Polynomial;

This should be a simple mechanical refactor.

主要言語
Rust
スター
25
フォーク
18
平均マージ
56分
マージ済み PR（30日）
1

環境構築

はじめの一歩

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

bcgit/bc-rust のほかの issue

bcgit/bc-rust の issue をすべて見る

似ている issue

Rust の issue をもっと見る

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

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