Category: Business Logic
Lack of documentation
Informational Severity
Informational Impact
N/A Likelihood
Description
Several files in the project are lacking documentation, the following being:
DateUtils.sol:
diffDays
DateUtils.sol:
_daysToDate
DateUtils.sol:
_daysFromDate
DateUtils.sol:
getYear
DateUtils.sol:
timestamp
Migrations.sol:
setCompleted
Impact
This is a source of developer confusion and a general coding hazard. Lack of documentation, or unclear documentation, is a major pathway to future bugs. It is best practice to document all code. Documentation also helps third-party developers integrate with the platform, and helps any potential auditors more quickly and thoroughly assess the code.
Recommendations
Add documentation to the affected functions.
Remediation
The issue has been acknowledged by Fractal.