balancer / balancer-core

Balancer on the EVM

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Outdated documentation

EricR opened this issue · comments

Description

Several pieces of documentation are outdated. For example, api.md references functions that no longer exist such as setFees. In another example, concepts.md lists functions in a table that should only be callable when the contract is in a "finalized" state, but many can be called at any time. The same document also lists "Conceptual Capabilities" that are not enforced anywhere in the codebase.

Incorrect documentation can make it more challenging for developers to understand the codebase, and increases the likelihood of introducing new bugs in the future.

Recommendation

Review all documentation for accuracy and make any necessary changes.

Docs updated for above