platformio / platformio/platformio-docs

platformio.project.helpers does not seem to be documented

Open
#78 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
285
Forks
357
PR merge metrics
No merged PRs in 30d

Description

I recently raised platformio/platformio-core#2971 where it was recommended that I use platformio.project.helpers ("PIO Core API"), but this feature doesn't seem to be documented anywhere on docs.platformio.org.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by checking the PIO Core API entry point platformio.project.helpers and the existing material on docs.platformio.org. Done means the publicly usable API is documented there with enough context for someone who was directed to it from platformio-core#2971.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.