Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor multivariate_calculus.py:chain_rule(f,xf,yf,zf,respect,s) #1

Open
AoWangPhilly opened this issue Dec 28, 2019 · 0 comments
Open

Comments

@AoWangPhilly
Copy link
Owner

I've selected multivariate_calculus.py:chain_rule(f,xf,yf,zf,respect,s) for refactoring, which is a unit of 16 lines of code and 6 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:

  • 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.

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: ✨ 💯

@AoWangPhilly AoWangPhilly added this to Done in Python Package Jun 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

1 participant