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

add ICON-Liskov integration style-guide #363

Merged
merged 14 commits into from
Jan 30, 2024
Merged

add ICON-Liskov integration style-guide #363

merged 14 commits into from
Jan 30, 2024

Conversation

huppd
Copy link
Contributor

@huppd huppd commented Jan 24, 2024

This PR adds a style-guide for LISKOV statements in ICON.

@huppd
Copy link
Contributor Author

huppd commented Jan 24, 2024

cscs-ci run default

@huppd
Copy link
Contributor Author

huppd commented Jan 24, 2024

launch jenkins spack

@samkellerhals
Copy link
Contributor

Some nitpicky comments. Could we put that into a docs folder inside tools, and also in the naming of the file use either - dashes or _ underscores.

Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be useful to have a short comment pointing users to the section on icon_liskov in the README.md to find out about the usage? https://github.com/C2SM/icon4py/blob/main/tools/README.md#icon_liskov

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, should be there now.

@huppd
Copy link
Contributor Author

huppd commented Jan 24, 2024

Some nitpicky comments. Could we put that into a docs folder inside tools, and also in the naming of the file use either - dashes or _ underscores.

Yes, that makes sense. Thanks. Should I move the README also in the new docs folder then?

huppd and others added 2 commits January 24, 2024 16:30
Co-authored-by: Samuel <kellerhalssamuel@gmail.com>
Co-authored-by: Samuel <kellerhalssamuel@gmail.com>
- `!$DSL END STENCIL` as close as possible to the original stencil section, no empty line before, one empty line after.
- `!$DSL START FUSED STENCIL` as close as possible to the original stencil sections, one empty line before, one empty line after.
- `!$DSL END FUSED STENCIL` as close as possible to the original stencil sections, one empty line before, one empty line after.
- `!$DSL INSERT` after `!$DSL START STENCIL`, no empty line before, one empty line after.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why does !$DSL INSERT have to be after !$DSL START STENCIL? Can't it be anywhere in the f90 file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree. I simplified it.

huppd and others added 3 commits January 24, 2024 16:30
Co-authored-by: Samuel <kellerhalssamuel@gmail.com>
Co-authored-by: Samuel <kellerhalssamuel@gmail.com>
Co-authored-by: Samuel <kellerhalssamuel@gmail.com>
Copy link
Contributor

@samkellerhals samkellerhals left a comment

Choose a reason for hiding this comment

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

A few more comments

@samkellerhals
Copy link
Contributor

Some nitpicky comments. Could we put that into a docs folder inside tools, and also in the naming of the file use either - dashes or _ underscores.

Yes, that makes sense. Thanks. Should I move the README also in the new docs folder then?

I guess to keep it consistent with the other namespace packages I would leave the README.md in the root of the folder and only move the style guide to this new docs folder.

Copy link
Contributor

@samkellerhals samkellerhals left a comment

Choose a reason for hiding this comment

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

Looks good!

@huppd
Copy link
Contributor Author

huppd commented Jan 24, 2024

Looks good!

Thanks for the improvements!

Copy link

Mandatory Tests

Please make sure you run these tests via comment before you merge!

  • cscs-ci run default
  • launch jenkins spack

Optional Tests

To run benchmarks you can use:

  • cscs-ci run benchmark

In case your change might affect downstream icon-exclaim, please consider running

  • launch jenkins icon

For more detailed information please look at CI in the EXCLAIM universe.

@huppd huppd marked this pull request as ready for review January 29, 2024 17:10
@huppd
Copy link
Contributor Author

huppd commented Jan 29, 2024

cscs-ci run default

@huppd
Copy link
Contributor Author

huppd commented Jan 29, 2024

launch jenkins spack

@huppd huppd merged commit d1bd837 into main Jan 30, 2024
5 checks passed
@samkellerhals samkellerhals deleted the add_liskov_styleguid branch December 20, 2024 08:39
OngChia pushed a commit that referenced this pull request Jan 14, 2025
This PR adds a style-guide for LISKOV statements in ICON.

Co-authored-by: Samuel <kellerhalssamuel@gmail.com>
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