Documentation for os.exec* functions omits information about required argument
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Documentation
All of the os.exec* functions (there are 8) require the path to the executable to be the first argument given to the executable, as well as specified in the path or file parameter of the exec method. The documentation of the exec* functions doesn't include any information about this requirement, however it can be found at the start of the Process management section of the documentation. I think it should be moved to the exec* function documentation.
Additionally I personally think that the discussion of the different variants of the function is a bit confusing and would be easier to understand if it was structured differently and a few headings were added.
I have some ideas about how to do this and intend to put together a pull request addressing the issues.
Linked PRs
- gh-125565
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Dokumentation zu os.exec* im verlinkten Abschnitt library/os.html#os.execl und vergleiche sie mit dem Abschnitt Process management. Lies den verlinkten PR gh-125565, bevor du beginnst; die Arbeit ist abgeschlossen, wenn das erforderliche Argument für den Pfad zur ausführbaren Datei bei den Funktionen dokumentiert ist und die Diskussion der Varianten klarer ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100