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 backend type docstrings #54

Merged
merged 2 commits into from
May 10, 2024
Merged

Conversation

adrhill
Copy link
Contributor

@adrhill adrhill commented May 10, 2024

Addresses issues brought up in #31 and on Slack.

Reasons for the addition of the "Exported from ADTypes.jl" string:

  • ADTypes are user-facing
  • ADTypes are re-exported by most packages using them
  • users might not be aware of parentmodule (see links above)

Copy link

codecov bot commented May 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (cb4eb36) to head (9b98c86).

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #54   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines           64        64           
=========================================
  Hits            64        64           
Flag Coverage Δ
docs 2.56% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ChrisRackauckas ChrisRackauckas merged commit d749b5a into SciML:main May 10, 2024
5 checks passed
@adrhill adrhill deleted the ah/docs branch May 10, 2024 22:07
@gdalle gdalle mentioned this pull request May 16, 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