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

Improve documentation #7

Open
5 of 9 tasks
ranocha opened this issue Oct 21, 2023 · 2 comments · Fixed by #96
Open
5 of 9 tasks

Improve documentation #7

ranocha opened this issue Oct 21, 2023 · 2 comments · Fixed by #96
Labels
documentation Improvements or additions to documentation

Comments

@ranocha
Copy link
Collaborator

ranocha commented Oct 21, 2023

  • Introduction including some background material
  • Tutorials
  • Benchmarks
  • More/improved docstrings

Docstrings can be added/modified in the source code. Documenter.jl will recognize them automatically and add them to the API reference. New pages need to be created as Markdown files in docs/src and have to be added to the list at the end of docs/make.jl.

@ranocha ranocha added the documentation Improvements or additions to documentation label Mar 25, 2024
@SKopecz SKopecz linked a pull request Jul 11, 2024 that will close this issue
@ranocha ranocha reopened this Jul 15, 2024
@ranocha
Copy link
Collaborator Author

ranocha commented Jul 15, 2024

I think there is more stuff we can/should add (see above)

@SKopecz
Copy link
Owner

SKopecz commented Jul 16, 2024

Sorry, I only wanted to mention this in the PR. I was not aware that it would be closed once the PR is merged.

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.

2 participants