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

example in docs #657

Merged
merged 1 commit into from
Aug 6, 2023
Merged

example in docs #657

merged 1 commit into from
Aug 6, 2023

Conversation

cossio
Copy link
Contributor

@cossio cossio commented Aug 6, 2023

The ForwardDiff docs are a bit strange: Introduction has no usage example, first entry of "User Documentation" is Limitations, then API reference, and then an Advanced section. Would be nice to start instead with a simple usage example.

I just copy/pasted the example from the README. I think this will be helpful for users that land on the docs page of the package without having seen the readme.

@codecov
Copy link

codecov bot commented Aug 6, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (e3670ce) 89.65% compared to head (e76c727) 89.65%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #657   +/-   ##
=======================================
  Coverage   89.65%   89.65%           
=======================================
  Files          11       11           
  Lines         967      967           
=======================================
  Hits          867      867           
  Misses        100      100           

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

@gdalle
Copy link
Member

gdalle commented Aug 6, 2023

Thanks for the contribution!

@gdalle gdalle merged commit 16417ec into JuliaDiff:master Aug 6, 2023
@cossio cossio deleted the doc branch August 6, 2023 22:46
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