dotnet / dotnet/dotnet-api-docs
System.IO.Ports.SerialPort.PortName should start with "/dev/" on Linux
- Vorherrschende Sprache
- C#
- Sterne
- 950
- Forks
- 1.7k
- Ø Merge
- 2 T. 19 Std.
- Gemergte PRs (30 T.)
- 52
Beschreibung
In , a user constructed ` System.IO.Ports.SerialPort` with "ttyACM0" as `PortName` on Linux and then wondered why it did not work. It would be useful to document that the port name on Linux should be an absolute path such as "/dev/ttyACM0", rather than only the basename "ttyACM0". This would go on the following pages:
- [SerialPort Constructors](https://docs.microsoft.com/dotnet/api/system.io.ports.serialport.-ctor?view=dotnet-plat-ext-3.1), in the description of the `portName` parameter of each constructor that has one
- [SerialPort.PortName Property](https://docs.microsoft.com/en-us/dotnet/api/system.io.ports.serialport.portname?view=dotnet-plat-ext-3.1)
The implementation of the SerialPort.GetPortNames() method appears to return names in the correct format already.
Beitragsleitfaden
Rechercherichtung
Überprüfe die verlinkten Seiten SerialPort Constructors und SerialPort.PortName Property mit besonderem Augenmerk auf die Beschreibungen des Parameters portName. Bestätige das bestehende Verhalten von GetPortNames() und dokumentiere anschließend, dass Linux-Portnamen absolute Pfade wie /dev/ttyACM0 sein sollten; die genannten Seiten sollten diese Anleitung danach enthalten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- csharp
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 55/100