Replaced isoareal quotient formula with sqrt of isperimetric quotient… #405
Conversation
…; docstring improvements
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #405 +/- ##
=======================================
- Coverage 82.7% 82.7% -0.0%
=======================================
Files 27 27
Lines 3829 3828 -1
=======================================
- Hits 3166 3165 -1
Misses 663 663
🚀 New features to boost your workflow:
|
|
If you install these to your env, then you should be able to build the docs by navigating to |
|
When I run |
|
I normally install editable versions of packages to my environment. pip install . -e |
Had to change to: pip install -e .which worked. Docs compiled successfully (I didn't break anything) and the equations rendered correctly. |
| Where :math:`A` is the area of the polygon and :math:`P` is the perimeter of the polygon. | ||
| However, the :math:`IAQ` is merely the square root of the Isoperimetric quotient, and is |
There was a problem hiding this comment.
| However, the :math:`IAQ` is merely the square root of the Isoperimetric quotient, and is | |
| With some manipulation, :math:`IAQ` can also be expressed as the square root of the Isoperimetric quotient, given by |
It's not clear what "however" is negating, and "merely" is condescending.
|
I've just got one change, and then it's all fine w/ me! |
Proposed fixes to #403 .
Commit includes the following changes:
_cast(). Replaces nested if; if; else with if;elif;else.isoareal_quotient()with square root ofisoperimetric_quotient(). Tested against builtin example datavirginia, and the new version yields the same result.isoperimetric_quotient()while providing LaTeX math formulas for both functions.I have tested the code, but regarding 3, I do not have my environment set up for producing documentation. I will follow up with someone on how to do that, but if a maintainer already has that set up and wants to check that the docstrings work, and in particular the math equations, that would be great.