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

Work on the documentation #4

Open
fedebenelli opened this issue Feb 3, 2024 · 2 comments · Fixed by #13
Open

Work on the documentation #4

fedebenelli opened this issue Feb 3, 2024 · 2 comments · Fixed by #13
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@fedebenelli
Copy link
Member

There is little to none documentation since the API rework. So it should be updated.

Also user level pages should be added to ease up the understanding process for the end-user.

@fedebenelli fedebenelli added the documentation Improvements or additions to documentation label Feb 3, 2024
@fedebenelli fedebenelli added this to the Better up code quality milestone Feb 3, 2024
@fedebenelli fedebenelli linked a pull request Feb 5, 2024 that will close this issue
@fedebenelli fedebenelli reopened this Feb 5, 2024
@fedebenelli
Copy link
Member Author

API documentation acceptable.
Still need to add individual pages for user documentation

@fedebenelli fedebenelli self-assigned this Mar 10, 2024
@fedebenelli
Copy link
Member Author

  • Individual pages
  • Check correct documentation of properties (for example, fugacity_vt gives $\phi_i P$ and not $f_i$)

@fedebenelli fedebenelli removed this from the Better up code quality milestone Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant