adafruit / adafruit/Adafruit_CircuitPython_PIOASM

Some of the examples go against a recommendation within the API documentation.

Open
#79 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
27
Forks
17
PR merge metrics
No merged PRs in 30d

Description

The recommendation is embedded within the codebase here:
https://github.com/adafruit/Adafruit_CircuitPython_PIOASM/blob/cf1dd1eb9605622327635ebfb47641c3366ef13c/adafruit_pioasm.py#L556-L558

It's eventually rendered as documentation here: https://docs.circuitpython.org/projects/pioasm/en/latest/api.html#adafruit_pioasm.assemble

Most examples embedded within this repo use the deprecated approach, but I did see at least one that uses the recommended approach:
https://github.com/adafruit/Adafruit_CircuitPython_PIOASM/blob/cf1dd1eb9605622327635ebfb47641c3366ef13c/examples/pioasm_7seg.py#L48-L52

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the recommendation in adafruit_pioasm.py around lines 556-558, then review the examples in the repository, using examples/pioasm_7seg.py lines 48-52 as the reference for the recommended approach. Update examples that use the deprecated approach and verify that the examples follow the API documentation recommendation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.