Stanford CS342 - Building for Digital Health
[Office Hours] Overriding Periphery CI check #120
-
Related Discussionhi! is there a way to override the periphery ci check in certain cases? for instance, we currently cant merge a change because periphery is failing; however, it is only failing due to unused variables/data structures that we do in fact plan to use in the future. 
Reproductionn/a Additional contextNo response Code of Conduct
|
Beta Was this translation helpful? Give feedback.
Replies: 1 comment
-
|
The checks are there to remove unused code so I would generally aim to remove all elements that are currently not needed and implement & test them as they become relevant in the app. It is challenging to maintain larger code bases with a lot of dead code and most of the time it won't be used after all. If you run into any false positives (e.g. the tool not detecting that a variable is actually used), you can use the ignore commends and a reasoning to disable these checks on a line-by-line basis. |
Beta Was this translation helpful? Give feedback.
The checks are there to remove unused code so I would generally aim to remove all elements that are currently not needed and implement & test them as they become relevant in the app. It is challenging to maintain larger code bases with a lot of dead code and most of the time it won't be used after all.
If you run into any false positives (e.g. the tool not detecting that a variable is actually used), you can use the ignore commends and a reasoning to disable these checks on a line-by-line basis.