Missing and incorrect documentation and specs for atomvm:posix_* functions

Đang mở
  • Có gì không ổn?
#2,029 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
erlang
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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/1
  • atomvm:posix_mkfifo/2
  • atomvm:posix_select_read/2
  • atomvm:posix_select_write/2
  • atomvm:posix_select_stop/2
  • atomvm: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.

Ngôn ngữ chính
Erlang
Star
2.3k
Fork
171
Merge trung bình
5 ngày 11 giờ
Pull request đã merge (30 ngày)
19

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của atomvm/AtomVM

Tất cả issue của atomvm/AtomVM

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.