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

add equations to API docs #182

Open
knaaptime opened this issue Jul 28, 2021 · 1 comment
Open

add equations to API docs #182

knaaptime opened this issue Jul 28, 2021 · 1 comment
Labels
good first issue Good for newcomers

Comments

@knaaptime
Copy link
Member

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 knaaptime added the good first issue Good for newcomers label Jul 28, 2021
@knaaptime
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant