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 docstrings and update documentation #182

Merged
merged 1 commit into from
Mar 11, 2024

Conversation

gdalle
Copy link
Member

@gdalle gdalle commented Mar 11, 2024

Fix #144, fix #181

  • Remove function signatures from README.md and add them as docstrings
  • Structure all docstrings on the docs/src/api.md page
  • Remove the additional comments from README.md and put them in the proper section of docs/src/api.md
  • Remove the tutorials from README.md and turn them into docs/src/tutorials.md (no doctests yet)
  • Copy-paste both README.md and docs/src/reproducibility.md into docs/src/index.md

I didn't manage to update Documenter to v1.3 (it complained about the reproducibility part), so I'm leaving it for a later PR

@gdalle gdalle changed the title Add docstrtings and update documentation Add docstrings and update documentation Mar 11, 2024
@gdalle
Copy link
Member Author

gdalle commented Mar 11, 2024

It looks like the downstream test fail on 1.6 has nothing to do with me? I didn't change the source code only the docstrings

@ChrisRackauckas
Copy link
Member

Thanks!

It looks like the downstream test fail on 1.6 has nothing to do with me? I didn't change the source code only the docstrings

We'll make this repo just follow the standard deprecation to LTS here.

@ChrisRackauckas ChrisRackauckas merged commit c667cf7 into JuliaDiff:master Mar 11, 2024
7 of 9 checks passed
@gdalle gdalle deleted the docstrings branch March 11, 2024 12:45
@gdalle
Copy link
Member Author

gdalle commented Mar 11, 2024

awesome! can a new release be tagged so that the cool doc becomes available?

@ChrisRackauckas
Copy link
Member

Already initiated.

@gdalle
Copy link
Member Author

gdalle commented Mar 11, 2024

Is it expected that the new documentation doesn't show up on https://docs.sciml.ai/FiniteDiff/stable/ nor https://juliadiff.org/FiniteDiff.jl/stable/?
And which one of those is the right URL?

@ChrisRackauckas
Copy link
Member

It needs to wait for the next global build

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

Successfully merging this pull request may close these issues.

What does "multi point derivatives" mean? Make a real documentation
2 participants