Definition 📖
Limit the number of parameters per unit to at most 4.
Why❓
Keeping the number of parameters low makes units easier to understand, test and reuse.
How 🔧
Reduce the number of parameters by grouping related parameters into objects. Alternatively, try extracting parts of units that require fewer parameters.
ℹ️ To know how many other refactoring candidates need addressing to get a guideline compliant, select some by clicking on the 🔲 next to them. The risk profile below the candidates signals (✅) when it's enough! 🏁
Good luck and happy coding! :shipit: :sparkles: :100:
github-actions[bot]
commented
3 years ago
I've selected MultiHeadSelfAttention.causal_attention_mask(n_dest,n_src,dtype) for refactoring, which is a unit of 5 lines of code and 3 parameters. Addressing this will make our codebase more maintainable and improve Better Code Hub's Keep Unit Interfaces Small guideline rating! 👍
Here's the gist of this guideline:
You can find more info about this guideline in Building Maintainable Software. 📖
ℹ️ To know how many other refactoring candidates need addressing to get a guideline compliant, select some by clicking on the 🔲 next to them. The risk profile below the candidates signals (✅) when it's enough! 🏁
Good luck and happy coding! :shipit: :sparkles: :100: