Missing and incorrect documentation and specs for atomvm:posix_* functions
Maintainers usually reply within 3 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- erlang
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Erlang
- Stars
- 2.3k
- Forks
- 171
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 20
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from atomvm/AtomVM
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 3 days
-
lwIP sockets: a failed listen or connect leaves the socket lock held, a later close hangs foreverOpen
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 3 days
Similar issues
-
area-multi-tenancy p1-recommended technical-debt
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
Docs: 2 broken linksOpenBug pulumi/pulumi-terraform-bridge R2 S2
Difficulty 1/5 Under an hour Newbie friendliness 72/100
pulumi/pulumi-terraform-bridge#3713 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
[Sync EN] Document the timezone of DateTime(Immutable)::createFromTimestamp() (#6074)Possibly taken @lacatoire claimed this today. Opensync-en
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
[Sync EN] Document the timezone of DateTime(Immutable)::createFromTimestamp() (#6074)Possibly taken A pull request linked to this issue is open or already merged. Opensync-en
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day