[ACELL02] Incomplete library.properties
file for the GSM library
#886
Labels
documentation
Improvements or additions to documentation
The GSM library included as part of the core is accessible for all users of the Arduino IDE who have a board with a supported
architecture
attached. There are several issues with this file from a User perspective:ArduinoCore-mbed/libraries/GSM/library.properties
Lines 1 to 9 in dd5abb6
version=1.0
since this file was created. Since then potentially breaking changes have been made, such as bed5201.sentence
isGSM wrapper
which does little to convey what this library does. As I understand from the commits, this library includes compiler directives specifically to provide functionality for the Portenta Edge Control.ArduinoCore-mbed/libraries/GSM/examples/GSMSSLClient/GSMSSLClient.ino
Lines 14 to 16 in dd5abb6
sentence
field must be a sentence explaining the purpose of the libraryparagraph
field is emptycategory
field is set toOther
, whileCommunication
seems more reasonableurl
field links to http://www.arduino.cc/en/Reference/GSM . This is the same url mentioned in arduino-libraries/GSM.Additional considerations
sentence
as well asparagraph
fields are not directly visible in the IDE, making sure the library is documented helps with contributors.#include "GSM.h"
)Arduino GSM Shield
(red) andis archived and is no longer maintained
(green). However, upon deeper inspection this seems to be regarding the arduino-libraries/GSM. The statementThe GSM Library is included with [Arduino IDE 1.0.4 and later](https://www.arduino.cc/en/Main/Software).
(blue) is however correct for the GSM library included inside the core and NOT the standalone libraryThe text was updated successfully, but these errors were encountered: