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

Fix Zalesak FCT docstring and add it to the Docs #910

Merged
merged 1 commit into from
Aug 25, 2022
Merged

Conversation

valeriabarra
Copy link
Member

This PR adds the Zalesak FCT operator to the docs since #887 did not include it. Plus some additional doc fixes and improvements.

  • Code follows the style guidelines OR N/A.
  • Unit tests are included OR N/A.
  • Code is exercised in an integration test OR N/A.
  • Documentation has been added/updated OR N/A.

@valeriabarra valeriabarra added the documentation Improvements or additions to documentation label Aug 23, 2022
Copy link
Contributor

@Zhengyu-Huang Zhengyu-Huang left a comment

Choose a reason for hiding this comment

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

look good for me! Thanks for the great effort

@valeriabarra
Copy link
Member Author

bors r+

bors bot added a commit that referenced this pull request Aug 24, 2022
910: Fix Zalesak FCT docstring and add it to the Docs r=valeriabarra a=valeriabarra

This PR adds the Zalesak FCT operator to the docs since #887  did not include it. Plus some additional doc fixes and improvements.

- [x] Code follows the [style guidelines](https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/) OR N/A.
- [x] Unit tests are included OR N/A.
- [x] Code is exercised in an integration test OR N/A.
- [x] Documentation has been added/updated OR N/A.


Co-authored-by: Valeria Barra <[email protected]>
@bors
Copy link
Contributor

bors bot commented Aug 24, 2022

Build failed:

@valeriabarra
Copy link
Member Author

bors r+

bors bot added a commit that referenced this pull request Aug 24, 2022
910: Fix Zalesak FCT docstring and add it to the Docs r=valeriabarra a=valeriabarra

This PR adds the Zalesak FCT operator to the docs since #887  did not include it. Plus some additional doc fixes and improvements.

- [x] Code follows the [style guidelines](https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/) OR N/A.
- [x] Unit tests are included OR N/A.
- [x] Code is exercised in an integration test OR N/A.
- [x] Documentation has been added/updated OR N/A.


Co-authored-by: Valeria Barra <[email protected]>
@bors
Copy link
Contributor

bors bot commented Aug 24, 2022

Build failed:

@valeriabarra
Copy link
Member Author

bors r+

bors bot added a commit that referenced this pull request Aug 24, 2022
910: Fix Zalesak FCT docstring and add it to the Docs r=valeriabarra a=valeriabarra

This PR adds the Zalesak FCT operator to the docs since #887  did not include it. Plus some additional doc fixes and improvements.

- [x] Code follows the [style guidelines](https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/) OR N/A.
- [x] Unit tests are included OR N/A.
- [x] Code is exercised in an integration test OR N/A.
- [x] Documentation has been added/updated OR N/A.


Co-authored-by: Valeria Barra <[email protected]>
@bors
Copy link
Contributor

bors bot commented Aug 24, 2022

Build failed:

@simonbyrne
Copy link
Member

bors r+

bors bot added a commit that referenced this pull request Aug 24, 2022
853: add special cases for projection from Covariant => Contravariant r=charleskawczynski a=simonbyrne



909: Fix differentiability of local element map r=simonbyrne a=simonbyrne

I was experimenting with `IntrinsicMap` and noticed some sign errors in the metric terms due to the non-differentiable extra branches for handling of signed zeros. This is a simpler and better approach.

- [X] Code follows the [style guidelines](https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/) OR N/A.
- [X] Unit tests are included OR N/A.
- [X] Code is exercised in an integration test OR N/A.
- [X] Documentation has been added/updated OR N/A.


910: Fix Zalesak FCT docstring and add it to the Docs r=simonbyrne a=valeriabarra

This PR adds the Zalesak FCT operator to the docs since #887  did not include it. Plus some additional doc fixes and improvements.

- [x] Code follows the [style guidelines](https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/) OR N/A.
- [x] Unit tests are included OR N/A.
- [x] Code is exercised in an integration test OR N/A.
- [x] Documentation has been added/updated OR N/A.


Co-authored-by: Simon Byrne <[email protected]>
Co-authored-by: Charles Kawczynski <[email protected]>
Co-authored-by: Valeria Barra <[email protected]>
@simonbyrne
Copy link
Member

bors r-

@bors
Copy link
Contributor

bors bot commented Aug 24, 2022

This PR was included in a batch that was canceled, it will be automatically retried

@bors
Copy link
Contributor

bors bot commented Aug 24, 2022

Canceled.

@simonbyrne
Copy link
Member

bors r+

@bors bors bot merged commit 701090c into main Aug 25, 2022
@bors bors bot deleted the valeria/fix-fct-docs branch August 25, 2022 02:48
@valeriabarra valeriabarra mentioned this pull request Sep 28, 2022
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants