arduino / arduino/ArduinoCore-API

Please consider refining (reorganizing/documenting) core headers to aid in their explicit inclusion ...

Ouverte
#121 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
C++
Étoiles
306
Forks
150
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

(I don't know if this is the correct place to begin this discussion, but if wrong please move it.)

Specifically I believe the current Arduino development environment is hurting beginners by hiding the inclusion of critical header files, which actually define the API's which programming relies upon, and who's inspection should be encouraged to aid beginners more easily understand why ideally well documented functions must be called with certain argument orders and types for example. Please consider reorganizing and refining Arduino's core library/environment header / implementation specification to allow it to more easily serve as a coherent reference to aid in its use; as also further supported by the following proposed changes:

- change default new project stationary to include "#include ", which need not be equivalent to "Arduino.h", although will likely include it among other base library headers, defining the base Arduinio API.

- initially continuing to support their magical inclusion behind the scenes, and thereby not breaking anything for existing projects, but beginning the transition to a requirement for its explicit top-level inclusion.

- add a feature to the IDE to make it easy to open and view included baseline headers, and those from optionally supported libraries (but possibly kept read-only by default, so beginners don't mistakenly modify them).

- in turn the source code can then be parsed to determine the code's corresponding library dependency required for compilation and linking, etc.

All visible to the user, as hiding such critical information typically hurts more than helps even, if not especially, beginners understand what's going on and why, in practice.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

L’issue n’identifie pas de fichiers ni de tests spécifiques. Commencez par examiner les en-têtes principaux de ArduinoCore-API ainsi que le comportement par défaut de Arduino IDE concernant les projets et l’inclusion des en-têtes, puis clarifiez le périmètre avec les maintainers. La tâche serait considérée comme terminée lorsqu’une approche approuvée existera pour des en-têtes de base explicites, la préservation des projets existants, l’inspection des en-têtes par l’IDE et la découverte des dépendances.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
cpp
Domaine
api, embedded-iot
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.