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

Documentation fixes #729

Merged
merged 5 commits into from
Jul 2, 2024
Merged

Documentation fixes #729

merged 5 commits into from
Jul 2, 2024

Conversation

abhro
Copy link
Contributor

@abhro abhro commented Jul 1, 2024

Checklist

  • Appropriate tests were added
    (none necessary, only documentation changed)
  • 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

Main changes

  • Identify method headers in docstrings (indents)
  • Use of backticks/monospace in names relating to code (and markdown deals with underscores as italics)
  • Fix markdown lists

@ChrisRackauckas ChrisRackauckas merged commit cf0f1bb into SciML:master Jul 2, 2024
28 of 40 checks passed
@abhro abhro deleted the abhro-patch-1 branch July 2, 2024 13:01
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.

2 participants