search

pysal / segregation

Segregation Measurement, Inferential Statistics, and Decomposition Analysis
https://pysal.org/segregation/
BSD 3-Clause "New" or "Revised" License
111 stars 26 forks source link

add equations to API docs #182

Open knaaptime opened 3 years ago

knaaptime commented 3 years ago

sometimes the same index carries different names in different fields (e.g. Herfindahl in econ versus Simpson's Diversity in biology), so we need to ensure the equation for each index is exposed in the documentation). The best way to do that is probably to include the equation in latex in the Notes section of each index's docstring, which should render it on on the API docs page (though open to other suggestions)

knaaptime commented 7 months ago

it would also be great if the latex equation string was available as an attribute of each class