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 missing Fortran documentation (1/2) #41

Merged
merged 27 commits into from
Oct 18, 2024

Conversation

alvrogd
Copy link
Collaborator

@alvrogd alvrogd commented Oct 15, 2024

Currently, approximately half of the Open Catalog's checks applicable to Fortran lack code examples in their respective README.md files.

This PR addresses part of the issue by identifying all checks that already have standalone Fortran code examples (separate files like example.f90) but are not yet used in the README.md entries. A follow-up PR will address the remaining checks with no Fortran code examples available.

These new Fortran code explanations are mainly a copy-paste from the already existing descriptions for the C codes. Note that, in some checks, the README.md uses simplified C and Fortran code examples instead of the ones provided as standalone files.

@alvrogd alvrogd self-assigned this Oct 15, 2024
@alvrogd alvrogd force-pushed the feature/AddMissingFortranDocumentation branch from c380e3f to 70d218e Compare October 15, 2024 11:22
@alvrogd alvrogd requested review from a team, ruifm and inaki-amatria and removed request for a team October 15, 2024 11:24
@alvrogd alvrogd marked this pull request as ready for review October 15, 2024 11:24
Copy link
Contributor

@inaki-amatria inaki-amatria 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!

Checks/PWR004/README.md Outdated Show resolved Hide resolved
Checks/PWR005/README.md Outdated Show resolved Hide resolved
Checks/PWR006/README.md Outdated Show resolved Hide resolved
Checks/PWR013/README.md Show resolved Hide resolved
Checks/PWR015/README.md Show resolved Hide resolved
Checks/PWR051/README.md Outdated Show resolved Hide resolved
Checks/PWR052/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ruifm ruifm left a comment

Choose a reason for hiding this comment

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

Great job, LGTM!

Comment on lines 113 to 114
Have a look at the following code:

Copy link
Contributor

Choose a reason for hiding this comment

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

nit: unnecessary, I would just remove this sentence

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Indeed, it doesn't add any value. For the sake of brevity, I've removed the sentence from all entries where it is repeated.

Copy link
Contributor

@jgonzac jgonzac left a comment

Choose a reason for hiding this comment

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

Nice!

Checks/PWR005/README.md Outdated Show resolved Hide resolved
@alvrogd alvrogd force-pushed the feature/AddMissingFortranDocumentation branch from 70d218e to 53da9a7 Compare October 18, 2024 07:30
@alvrogd alvrogd force-pushed the feature/AddMissingFortranDocumentation branch from 53da9a7 to 1ad58ea Compare October 18, 2024 07:39
@alvrogd alvrogd merged commit 1ad58ea into main Oct 18, 2024
4 checks passed
@alvrogd alvrogd deleted the feature/AddMissingFortranDocumentation branch October 18, 2024 07:43
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.

4 participants