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

Migrate hydro power formulation library into API #52

Open
3 tasks
kdayday opened this issue Dec 30, 2024 · 0 comments
Open
3 tasks

Migrate hydro power formulation library into API #52

kdayday opened this issue Dec 30, 2024 · 0 comments

Comments

@kdayday
Copy link

kdayday commented Dec 30, 2024

Currently, there are docstrings for formulations in the API, using non-references to the docstrings in the formulation library. To follow the Diataxis format, the formulation library should be with the api under a reference section.

  • move APIs into reference section
  • disperse formulation library into docstrings for each formulation Type
  • ideally, this would likely manually break up the public API into sub-pages by topic (i.e. Formulations is its own page, rather than section)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant