Fix `rtc.calibration` supported-port list documentation

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

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

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

評価

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

調査の方向性

rtc.calibration のドキュメントは shared-bindings の RTC モジュールにある docstring から生成されるため、まず RTC バインディングのソースと、issue にリンクされたフォーラムのスレッドを確認してください。ports ディレクトリを検索して、どのポートがキャリブレーションを実装しているかを調べ、docstring の対応ポート一覧をそれに合わせて修正してください。ドキュメントがキャリブレーションを実装しているポートをちょうど過不足なく挙げており、ドキュメントのビルドがエラーなく完了すれば完了です。

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

説明

documentation

The documentation for RTC.calibration is incorrect about on which ports it's supported.

https://forums.adafruit.com/viewtopic.php?t=225857

主要言語
C
スター
4.6k
フォーク
1.4k
平均マージ
1日
マージ済み PR（30日）
212

環境構築

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

はじめの一歩

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

adafruit/circuitpython のほかの issue

adafruit/circuitpython の issue をすべて見る

似ている issue

C の issue をもっと見る

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

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