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

Changes after rename of CCPPStandardNames --> ESMStandardNames #98

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

mkavulich
Copy link
Collaborator

  • Remove references to CCPP except where relevant
  • Cherry-pick changes to tools/write_standard_name_table.py from release branch that allows for subsections in standard names and markdown table
  • Group CCPP-specific variables into a dedicated section
  • Change some long_name descriptions to remove CCPP-specific wording
  • A few more details in README.md

 - Remove references to CCPP except where relevant
 - Cherry-pick changes to tools/write_standard_name_table.py from release branch
   that allows for subsections in standard names and markdown table
 - Group CCPP-specific variables into a dedicated section
 - Change some long_name descriptions to remove CCPP-specific wording
 - A few more details in README.md
Copy link
Collaborator

@gold2718 gold2718 left a comment

Choose a reason for hiding this comment

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

I mostly have a suggestion and some questions but I wonder why useful comments need to be removed.

# end while
# end if
for std_name in section:
for std_name in sec:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a reason these comments must be removed? We have been using them for years and they are very helpful for those of us with vision issues.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have a few arguments against including these comments. They require a non-trival amount of effort to ensure they are always correct, and it is not lintable so this will always be a manual effort. And if they are not kept up-to-date it does more harm than good. I am sympathetic to the needs of individual coding workflows, but can these kinds of decorations not be handled with IDE settings? I know Pycharm is extremely configurable, for example, and there are a number of suggestions online for people in similar situations.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can this at least be a group discussion / decision instead of a unilateral change? Has this been discussed?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It has not been discussed widely; these changes originally came from the release/v1 branch so I did not realize they would be controversial. I can revert them from this PR for now and open an issue for wider discussion.

mkavulich and others added 2 commits March 6, 2025 07:56
Include link to StandardNameRules.rst

Co-authored-by: goldy <1588651+gold2718@users.noreply.github.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