Skip to content

Conversation

@fcuantico
Copy link
Contributor

NWChemEx extension conventions for various file types

Is this pull request associated with an issue(s)?
No this is adding new content to the documentation

Description
Description of the extension to different file types

TODOs
For draft pull requests please include a list of what needs to be done and check
off items as you complete them.

NWChemEx extension conventions for various file types
Comment on lines 34 to 38
In NWChemEx the following convetions are followed:
C++ header: file_name.hpp
C++ source files: file_name.cpp
CMake source files : filename.cmake
CMake Lists: CMakeLists.txt
Copy link
Member

@jwaldrop107 jwaldrop107 Dec 23, 2024

Choose a reason for hiding this comment

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

Suggested change
In NWChemEx the following convetions are followed:
C++ header: file_name.hpp
C++ source files: file_name.cpp
CMake source files : filename.cmake
CMake Lists: CMakeLists.txt
In NWChemEx the following convetions are followed:
- C++ header: file_name.hpp
- C++ source files: file_name.cpp
- CMake source files : filename.cmake
- CMake Lists: CMakeLists.txt

The formatting needs to be corrected to be a proper list. But I would move the information intended here to the files about the particular languages, e.g. move the note on C++ file extensions to cxx_conventions.rst. Or the full section can be moved to file_structure.rst, maybe.

@ryanmrichard
Copy link
Member

@jwaldrop107 and @fcuantico what do you think of these changes?

Copy link
Member

@jwaldrop107 jwaldrop107 left a comment

Choose a reason for hiding this comment

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

LGTM

@ryanmrichard ryanmrichard merged commit 93f19d5 into master Dec 30, 2024
4 checks passed
@ryanmrichard ryanmrichard deleted the fcuantico-patch-3-1 branch December 30, 2024 15:15
@jwaldrop107
Copy link
Member

🚀 [bumpr] Bumped! New version:v0.3.62 Changes:v0.3.61...v0.3.62

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