foundry-rs / foundry-rs/forge-std

docs: enhance documentation with NatSpec for all public functions

Đang mở
#653 1 bình luận 1 reaction 0 người được giao Xem trên GitHub
documentation help wanted
Ngôn ngữ chính
Solidity
Star
1.1k
Fork
520
Merge trung bình
3 ngày 13 giờ
Pull request đã merge (30 ngày)
9

Mô tả

Related: https://github.com/foundry-rs/book/issues/1303

To do:

- [x] Interfaces https://github.com/foundry-rs/forge-std/pull/666
- [ ] Base.sol
- [ ] console.sol
- [ ] console2.sol
- [ ] safeconsole.sol
- [ ] Script.sol
- [x] StdAssertions.sol
- [x] StdChains.sol https://github.com/foundry-rs/forge-std/pull/860
- [x] StdCheats.sol https://github.com/foundry-rs/forge-std/pull/860
- [ ] StdError.sol
- [x] StdInvariant.sol
- [x] StdJson.sol https://github.com/foundry-rs/forge-std/pull/860
- [ ] StdMath.sol
- [x] StdStorage.sol https://github.com/foundry-rs/forge-std/pull/860
- [x] StdStyle.sol https://github.com/foundry-rs/forge-std/pull/860
- [x] StdToml.sol https://github.com/foundry-rs/forge-std/pull/860
- [ ] StdUtils.sol
- [ ] Test.sol
- [ ] Vm.sol

Goals:

- [x] Document all public facing functions with `@notice`
- [x] Mark private variables and functions with underscore prefix https://github.com/foundry-rs/forge-std/pull/861
- [ ] Unify layouts to follow common best practices of grouping storage variables
- [ ] Move internal functions up, private functions down
- [ ] Should not modify any user facing function or interface

This will make it easier to autogenerate documentation that we can then load into https://book.getfoundry.sh/reference/forge-std/ and keep it up to date

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Xem xét các tệp còn lại chưa được đánh dấu được liệt kê trong issue, bao gồm Base.sol, console.sol, Script.sol, StdError.sol, StdMath.sol, StdUtils.sol, Test.sol và Vm.sol, cùng với book issue liên quan. Trước tiên, hãy kiểm tra NatSpec hiện có trong các tệp đã hoàn thành; hoàn thành nghĩa là ghi tài liệu cho tất cả các hàm hướng ra công chúng mà không thay đổi các interface hướng tới người dùng, đồng thời xử lý các mục tiêu còn lại về layout và thứ tự hàm nếu chúng vẫn nằm trong phạm vi.

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

Đánh giá

Công nghệ
solidity
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
38/100

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.