TODOs and FIXMEs should be resolved SW-D1000
TODO/FIXME comments are usually placed within the source code to indicate that there might be a scenario that is either unaccounted for or that a feature requires further enhancements. In either way, they must be addressed when and where possible to avoid unintended side-effects or breakdown.
Missing documentation comment SW-D1001
It is recommended to have documentation comments above functions, methods, classes and protocols. This helps library users, other developers and even the author to understand the purpose of a code snippet or an API function in the future.
NOTE: If you want to stop this issue from getting raised on certain constructs consider using the skipdoccoverage option under the analyzers.meta property in your .deepsource.toml file.
For example, the following configuration will silence this issue for classes and protocols:
[analyzers.meta]
skip_doc_coverage = ["class", "protocol"]