-
Notifications
You must be signed in to change notification settings - Fork 8
Rename filename comments #325
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
Conversation
| // set up in cncult.cpp; format is for vrUnspool. vrpak.h struct. | ||
|
|
||
| //---------------------- CGSOLAR.CPP PUBLIC VARIABLE ------------------------ | ||
| //---------------------- cgsolar.cpp PUBLIC VARIABLE ------------------------ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a tricky one. The file name is now consistent, but it is not consistent with the rest of the context here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean that since all the titles are upper case it possibly needs to stay that way? or we can add quotes to imply that is a file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not saying it "needs" to be one way or the other. I'm just pointing out the new inconsistency you introduced and trying to understand why you came to the conclusion you did. I'm not saying it's wrong. Ultimately this specific case doesn't matter much at all. What really matters is that we are conscious of inconsistencies (even the more minor ones) and address them if possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a non-issue compared to the fact that we have comments that say PUBLIC VARIABLES and FUNCTION DECLARATIONS at all.
src/ashwface.h
Outdated
|
|
||
| /////////////////////////////////////////////////////////////////////////////// | ||
| // ashwface.h -- defns and decls for ASHWAT interface | ||
| // ashwface.h -- defns and decls for ashwat interface |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did you lower case this?
|
|
||
| /////////////////////////////////////////////////////////////////////////////// | ||
| // CSE.cpp : Main program module | ||
| // cse.cpp : Main program module |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In our last iteration meeting, we touched upon the fact that the CSE executable name is in all caps, and maybe would remain that way. Does that argue for cse.h and cse.cpp to stay capitalized too? Obviously we can have CMake call the exe whatever we want, but in a simple build the file with main() would be the name of the binary.
|
@galanCA there are unresolved comments in this PR. Do you plan to make any changes still? |
Description
Renames the filename in the file description to keep consistency with the case of the filename. It also renames XMODULE in cmakelist to lower case. The author checked by doing a case sensitive search for all the files.
Author Progress Checklist:
Reviewer Checklist: