facebook / facebook/buck2

API documentation is highly incomplete

Open
#185 1 comment 1 reaction 0 assignees View on GitHub
documentation
Dominant language
Rust
Stars
4.4k
Forks
394
PR merge metrics
No merged PRs in 30d

Description

Consider the `cxx_toolchain()` API (https://buck2.build/docs/api/rules/#cxx_toolchain).

There are only 7 documented arguments, and a whopping 99 total arguments. A similar ratio exists for many other APIs. Note that the `cxx_toolchain()` API has no _self_ documentation either (what is this API, why do you use it, example invocation, etc) and that also is pervasive among the API documentation.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.