Missing and incorrect documentation and specs for atomvm:posix_* functions
I maintainer di solito rispondono entro 2 giorni
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 55/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- erlang
- Ambito
- documentation
Direzione di ricerca
Read posix_nifs.c and the atomvm module documentation to identify the listed functions and compare their documented behavior with the NIF implementations. Add documentation and specs for the listed functions and atomvm:file_get_cwd/0, and correct the posix_write/2 reference; done when each named function is documented accurately and has a useful spec. No test file or test command is named in the issue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
The documentation for atomvm:posix_write/2 states:
Write data to a file. Files are open non-blocking. ˋatomvm:posix_select_write/3` can be used to determine if the file can be written.
The function ˋatomvm:posix_select_write/3` does not seem to be implemented in posix_nifs.c
Several other nifs in posix_nifs.c are not documented, since these are not standard functions from an OTP module users will have no way of knowing they exist. These functions include:
atomvm:posix_closedir/1atomvm:posix_mkfifo/2atomvm:posix_select_read/2atomvm:posix_select_write/2atomvm:posix_select_stop/2atomvm:posix_unlink/1
Also in the atomvm module atomvm:file_get_cwd/0 is lacking documentation.
As well as making the existence of these functions known to users, specs would be beneficial for dialyzer.
- Lingua principale
- Erlang
- Stelle
- 2.3k
- Fork
- 171
- Merge medio
- 5g 11h
- PR unite (30g)
- 19
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di atomvm/AtomVM
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
I maintainer di solito rispondono entro 2 giorni
-
unicode:characters_to_list/binary return an uninitialized term for a non-chardata argumentForse già presa Una pull request collegata a questa issue è aperta o già unita. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 77/100
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 67/100
atomvm/AtomVM#2435 · 1 commento · 1 reazione ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
atomvm/AtomVM#2429 · 1 reazione ·
I maintainer di solito rispondono entro 2 giorni
Tutte le issue di atomvm/AtomVM
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
bytedance/agentkit-samples#277 ·
-
pending close triaging
Difficoltà 1/5 1-3 ore Idoneità per principianti 74/100
anomalyco/opencode#63090 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Contribute FeedbackAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 67/100
MicrosoftDocs/WSL#2654 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 85/100
hibernate/hibernate-reactive#4485 ·
I maintainer di solito rispondono entro 1 giorno