platformio / platformio/platformio-docs

Clarify language on FAQ: Convert .ino to C++ files "Manually"?

Open
#137 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In the faq, there is a section describing common changes you may need to make to .ino files to make them work as .cpp.

The header of this section uses the word "Manually" at the end, which implies that there is an automated way of doing this somewhere.

This can cause confusion (see https://github.com/Bodmer/TFT_eSPI/pull/637)

I haven't found anywhere in the docs where there is automatic handling of these by platformio prior to running the compile.

I think the language can be cleared up a little to reduce confusion.

I'd be happy to submit a PR with suggested language, if someone can confirm for me that there is not any automation to make .ino files compatible with .cpp built into platformio?

The first sentence of that document also does not make sense. I'm not sure what it's trying to say or imply by Some Cloud & Desktop IDE doesn’t support Arduino files

This again reinforces the implication that platformio does handle this... but then why does it go on to describe the changes you need to make?

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 with the FAQ section about converting .ino files to .cpp files manually and review its heading and opening sentence. Check the context from pull request 637 and clarify the wording so it does not imply undocumented automation; done means both confusing statements are understandable and accurate.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.