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

[docs] clarify section on automatic differentiation in nonlinear.md #3683

Merged
merged 7 commits into from
Feb 29, 2024
Merged

Conversation

Copy link

codecov bot commented Feb 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.33%. Comparing base (4be967c) to head (702a54a).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3683   +/-   ##
=======================================
  Coverage   98.33%   98.33%           
=======================================
  Files          43       43           
  Lines        5696     5696           
=======================================
  Hits         5601     5601           
  Misses         95       95           

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

docs/src/manual/nonlinear.md Outdated Show resolved Hide resolved
docs/src/manual/nonlinear.md Outdated Show resolved Hide resolved
docs/src/manual/nonlinear.md Outdated Show resolved Hide resolved
@odow
Copy link
Member Author

odow commented Feb 27, 2024

How about this now. I don't really know where the trade-off is between providing lots of information one the details for expert users, and trying to hide irrelevant information for new users.

docs/src/manual/nonlinear.md Outdated Show resolved Hide resolved
@@ -161,6 +161,14 @@ julia> sin(sin(1.0))
0.7456241416655579
```

## Automatic differentiation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a second section about AD at the bottom, I would move this down with the rest

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kept the section. I wanted to distinguish general AD from the AD specific to operators. The bottom section was ## instead of ### by mistake, so it looked more prominent than I intended.

docs/src/manual/nonlinear.md Outdated Show resolved Hide resolved
docs/src/manual/nonlinear.md Outdated Show resolved Hide resolved
@odow odow merged commit 65a4946 into master Feb 29, 2024
11 checks passed
@odow odow deleted the od/ad branch February 29, 2024 03:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants