Fix `rtc.calibration` supported-port list documentation

Open Beginner friendly
#11,877 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
c, python

Research direction

The rtc.calibration docs come from the docstring in the shared-bindings RTC module, so start with the RTC binding source and the forum thread linked in the issue. Search the port directories for which ones implement calibration, and correct the supported-port list in the docstring to match. Done when the docs name exactly the ports that implement it and the documentation builds cleanly.

Written by the indexing model from the issue text.

Description

documentation

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

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

Dominant language
C
Stars
4.6k
Forks
1.4k
Avg merge
1d
Merged PRs (30d)
212

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from adafruit/circuitpython

All issues in adafruit/circuitpython

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.