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 list of exports #23

Merged
merged 3 commits into from
Mar 8, 2024
Merged

Add docstrings and list of exports #23

merged 3 commits into from
Mar 8, 2024

Conversation

gdalle
Copy link
Collaborator

@gdalle gdalle commented Mar 8, 2024

Checklist

  • Appropriate tests were added
  • Any code changes were done in a way that does not break public API
  • All documentation related to code changes were updated
  • The new code follows the
    contributor guidelines, in particular the SciML Style Guide and
    COLPRAC.
  • Any new documentation only uses public API

Additional context

I'm not sure whether the lack of documentation is a bug or a feature. This is a pretty young and experimental package, so arguably we don't want to expose too much of the internals.

On the other hand it already has 18 registered direct dependents and 492 indirect ones. I would assume those dependents use "the code as the documentation", which means everything is API by default. This PR makes the API more explicit and discoverable.

@Vaibhavdixit02 Vaibhavdixit02 merged commit 0af4052 into SciML:main Mar 8, 2024
3 checks passed
@gdalle gdalle deleted the docstrings branch March 8, 2024 21:21
@gdalle gdalle mentioned this pull request Mar 9, 2024
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.

None yet

2 participants