Documentation inconsistencies
Description
The function documentation is sometimes incorrectly stating what the function does, or when it can be called. Examples:
settleTerminatedRailWithoutValidation
is documented as (our emphasis):
Settles payments for a terminated rail without validation. This may only be called by the payee and after the terminated rail's max settlement epoch has passed. It's an escape-hatch to unblock payments in an otherwise stuck rail (e.g., due to a buggy validator contract) and it always pays in full.
Of course, the payee should never be able to forcibly terminate a rail without validation. This is an emergency function used for the client or the payer, not the payee. The function is correctly implemented, but documented wrong.
Impact
N/A
Recommendations
Remove the mapping and the related comment
Remediation
This issue has been acknowledged by Filecoin Services, and a fix was implemented in PR #206↗.