Skip to content

Update index.rst #169

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.

Sign up for GitHub

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

Merged
ryanmrichard merged 3 commits into from
Dec 30, 2024
Merged

Update index.rst #169

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c0f6df
Update index.rst
fcuantico Dec 20, 2024
536c84b
Update index.rst
fcuantico Dec 23, 2024
e81d443
move file conventions
ryanmrichard Dec 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/source/conventions/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,9 @@ Repository Conventions
:maxdepth: 2

file_structure

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 •
edited
Loading

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.

Loading