documentation clarification#267
Merged
shakedregev merged 1 commit intofrontmatter-devfrom May 13, 2025
Merged
Conversation
Collaborator
|
Closing this PR for now. We'll reopen it when it is ready to merge. |
pelesh
pushed a commit
that referenced
this pull request
Jun 21, 2025
shakedregev
added a commit
that referenced
this pull request
Oct 3, 2025
shakedregev
added a commit
that referenced
this pull request
Oct 3, 2025
* fix some more memory leaks and add ubsan support to `CMakeLists.txt` (#320) * Fix bug in KLU class affecting non-symmetric linear systems (#323) * Update Spack and setup CI with asan and ubsan variants (#322) * Point Spack to upstream v0.23.1. * Update Frontier modules after Spack upgrade. * Frontier build with +asan+ubsan. * Temporarily point Spack to nkoukpaizan-fork to add asan and ubsan. * +asan+ubsan in GH Actions. * CMake targets for asan and ubsan. * ~asan~ubsan Spack builds on Frontier by default. * Try running CI tests within spack build-env to address the issue of the consumer test not finding the appropriate compiler. * Alias for spack environment in CI. * Revert "Alias for spack environment in CI." This reverts commit fd263ae. * Using `${OLDPWD}` to identify Spack environment. * Add warnings flags to CMake configuration. (#325) --------- Co-authored-by: pelesh <peless@ornl.gov> * fix the means by which cmake finds the suitesparse include dir (#327) * Fixed GLU to work on non-symmetric matrices. Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Synchronize devices after HIP functions (#336) * synchronize devices after HIP functions * Apply pre-commmit fixes * Update resolve/matrix/MatrixHandlerHip.cpp * fixed CUDA * fixed CUDA * Apply pre-commmit fixes * Update resolve/matrix/MatrixHandlerCuda.cpp * Revert "Update resolve/matrix/MatrixHandlerCuda.cpp" This reverts commit 30e41bb. * Revert "Apply pre-commmit fixes" This reverts commit 0bcd8f7. * Revert "fixed CUDA" This reverts commit 62623fa. * Revert "fixed CUDA" This reverts commit b9b249b. --------- Co-authored-by: Shaked Regev <shakedvregev@gmail.comregev@gmail.com> Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Added the ability to reset a workspace without completely destroying it. (#343) * added method to reset workspace * changed tests * added reset workspace to CUDA * now with comments * Apply pre-commmit fixes * Update resolve/workspace/LinAlgWorkspaceCpu.cpp --------- Co-authored-by: Shaked Regev <shakedvregev@gmail.comregev@gmail.com> Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Enforce F being 0 and remove duplicate extract factors code * added check for F!=0 * enforce F being 0 and clean up factor extraction code duplication * Apply pre-commmit fixes * Update resolve/LinSolverDirectKLU.cpp * cleaned up comments * Apply pre-commmit fixes * Update resolve/LinSolverDirectKLU.cpp --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Properly address CSR and CSC discrepancies across all solvers. Fixed discrepancies with minimal overhead. --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> Co-authored-by: pelesh <peless@ornl.gov> * Put sorting within KLU instead of within other solver logic. (#359) * Adding asymmetric tests (from the data folder) for KLU, CuSolver, and RocSolver. (#364) * tests that are supposed to pass are passing * fixed typos, removed unnecessary file * Apply pre-commmit fixes * renamed matrix files (not added before accidentally) * removed commented out code * fixed failing tests * Apply pre-commmit fixes * fixed commented out code * straggling comment * Update tests/functionality/CMakeLists.txt * Update tests/functionality/CMakeLists.txt * Update tests/functionality/CMakeLists.txt * fixed data path for lusol * consumer * fixed typo * changing to sys refactor, which requires a path * Fix for resolve_consumer to take in the matrices and right hand sides (#365) * Passing matrices and rhs to resolve_consumer. * Minor typo cuda-->hip * adding generic test matrices * modified numbering to suffix * tests failing with well conditioned matrix * updating to better conditioned matrices * SPD test passes consistently, others don't * still testing * changed matrices * updated matrices * changed test mats * changed matrices * symmetric test passing, asymmetric passing when run separately, but not through make test * changed matrices * changed tolerance to machine precision, tests pass! * Apply pre-commmit fixes * updated consumer * fixed non IR related comments * removed IR check, it passes with IR with the better scaled matrices * Apply pre-commmit fixes * Update tests/functionality/CMakeLists.txt * tests passing * Apply pre-commmit fixes * fixed prints * set convergence conditions * setting convergence condition, but it's overridden * set default to relative residual * added default conv_cond * Apply pre-commmit fixes * Update examples/resolve_consumer/CMakeLists.txt * addressed comment * reverted change that made CI test not pass * made matrices consistent, tolerance too stringent * tests passing, renamed files to be consistent * addressed all comments, only tested on Frontier * addressed comments * removed straggling print --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> Co-authored-by: Nicholson Koukpaizan <72402802+nkoukpaizan@users.noreply.github.com> * Shaked/rework examples csr (#367) * fixed examples * kalmarek example * moved to experimental, kalmarek example works * removed commented code * Apply pre-commmit fixes * Update examples/experimental/CMakeLists.txt * addressed change requests * changed cmake --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Fixed experimental examples to use CSR only. * removed unnecessary Csc reference from examples * removed build files * fixed segfault * fixed glu update * fixed all experimental examples * somehow this segmentation fault fix didn't save * fixed fgmres * Apply pre-commmit fixes * Update examples/experimental/r_KLU_cusolverrf_redo_factorization.cpp * Update examples/experimental/r_KLU_cusolverrf_redo_factorization.cpp * Update examples/experimental/r_KLU_cusolverrf_redo_factorization.cpp --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Fix warning on r_KLU_rocsolverrf_asym6x6 * Fix warning on r_KLU_rocsolverrf_asym6x6. --------- Co-authored-by: nkoukpaizan <nkoukpaizan@users.noreply.github.com> Co-authored-by: Shaked Regev <35384901+shakedregev@users.noreply.github.com> * Removed all CSC code from CSR solvers. (#375) * removed all CSC code * Apply pre-commmit fixes * Update tests/functionality/testRefactor.cpp --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Removed rocSparse "fast" solver from our options (#377) Removed all "fast" solver code. --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Updated changelog and PR template (#381) * Update emails in README.md * Add code of conduct. * Move code of conduct. * Add badges * Change action name to CPU Tests * Update README.md * Add logo to the README file. * Add logo to readthedocs. * Manage images for light/dark schemes in README. * Add logo to Doxygen docs. * Fix path to logo in Doxygen. * Update logos * Add svg logo images. * Update README.md * Update doxygen landing page. * Monor changes to Doxygen landing page * Updated coding and developer guidelines (#242) Added details about implicit coding guidelines that were not specified. Added suggested branching workflow. Added PR reviewing and opening and issue guidelines. Fixed typos Restructured documentation sections Co-authored-by: pelesh <peless@ornl.gov> * Update readthedocs links in README.md Updated links in README to pint to readthedocs pages generated from `frontmatter-dev` branch. This needs to be reverted before merging. * documentation clarification (#267) * fixing typos * fixed typos * Restructured documentation files (#299) --------- Co-authored-by: Adham Ibrahim <37982706+adham-ibrahim7@users.noreply.github.com> Co-authored-by: Slaven Peles <peless@ornl.gov> * Apply pre-commmit fixes * Use Re::Solve instead of ReSolve and update Doxygen logo. * Simplify doxygen stylesheet, allow dark mode * [skip ci] Revert sidebar-only mode. * [skip ci] Another shot on sidebar only doxy theme * ReSolve -> Re::Solve * Apply pre-commmit fixes * Copy Doxyfile.in -> Doxyfile and then modify. * updated contributors * straggling changes * Use correct Doxyfile * Undo doxyfile template changes * rebased frontmatter-dev --------- Co-authored-by: superwhiskers <whiskerdev@protonmail.com> Co-authored-by: Nicholson Koukpaizan <72402802+nkoukpaizan@users.noreply.github.com> Co-authored-by: pelesh <peless@ornl.gov> Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> Co-authored-by: Shaked Regev <shakedvregev@gmail.comregev@gmail.com> Co-authored-by: nkoukpaizan <nkoukpaizan@users.noreply.github.com> Co-authored-by: Adham Ibrahim <37982706+adham-ibrahim7@users.noreply.github.com> Co-authored-by: pelesh <pelesh@users.noreply.github.com>
shakedregev
added a commit
that referenced
this pull request
Oct 3, 2025
shakedregev
added a commit
that referenced
this pull request
Oct 3, 2025
* fix some more memory leaks and add ubsan support to `CMakeLists.txt` (#320) * Fix bug in KLU class affecting non-symmetric linear systems (#323) * Update Spack and setup CI with asan and ubsan variants (#322) * Point Spack to upstream v0.23.1. * Update Frontier modules after Spack upgrade. * Frontier build with +asan+ubsan. * Temporarily point Spack to nkoukpaizan-fork to add asan and ubsan. * +asan+ubsan in GH Actions. * CMake targets for asan and ubsan. * ~asan~ubsan Spack builds on Frontier by default. * Try running CI tests within spack build-env to address the issue of the consumer test not finding the appropriate compiler. * Alias for spack environment in CI. * Revert "Alias for spack environment in CI." This reverts commit fd263ae. * Using `${OLDPWD}` to identify Spack environment. * Add warnings flags to CMake configuration. (#325) --------- Co-authored-by: pelesh <peless@ornl.gov> * fix the means by which cmake finds the suitesparse include dir (#327) * Fixed GLU to work on non-symmetric matrices. Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Synchronize devices after HIP functions (#336) * synchronize devices after HIP functions * Apply pre-commmit fixes * Update resolve/matrix/MatrixHandlerHip.cpp * fixed CUDA * fixed CUDA * Apply pre-commmit fixes * Update resolve/matrix/MatrixHandlerCuda.cpp * Revert "Update resolve/matrix/MatrixHandlerCuda.cpp" This reverts commit 30e41bb. * Revert "Apply pre-commmit fixes" This reverts commit 0bcd8f7. * Revert "fixed CUDA" This reverts commit 62623fa. * Revert "fixed CUDA" This reverts commit b9b249b. --------- Co-authored-by: Shaked Regev <shakedvregev@gmail.comregev@gmail.com> Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Added the ability to reset a workspace without completely destroying it. (#343) * added method to reset workspace * changed tests * added reset workspace to CUDA * now with comments * Apply pre-commmit fixes * Update resolve/workspace/LinAlgWorkspaceCpu.cpp --------- Co-authored-by: Shaked Regev <shakedvregev@gmail.comregev@gmail.com> Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Enforce F being 0 and remove duplicate extract factors code * added check for F!=0 * enforce F being 0 and clean up factor extraction code duplication * Apply pre-commmit fixes * Update resolve/LinSolverDirectKLU.cpp * cleaned up comments * Apply pre-commmit fixes * Update resolve/LinSolverDirectKLU.cpp --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Properly address CSR and CSC discrepancies across all solvers. Fixed discrepancies with minimal overhead. --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> Co-authored-by: pelesh <peless@ornl.gov> * Put sorting within KLU instead of within other solver logic. (#359) * Adding asymmetric tests (from the data folder) for KLU, CuSolver, and RocSolver. (#364) * tests that are supposed to pass are passing * fixed typos, removed unnecessary file * Apply pre-commmit fixes * renamed matrix files (not added before accidentally) * removed commented out code * fixed failing tests * Apply pre-commmit fixes * fixed commented out code * straggling comment * Update tests/functionality/CMakeLists.txt * Update tests/functionality/CMakeLists.txt * Update tests/functionality/CMakeLists.txt * fixed data path for lusol * consumer * fixed typo * changing to sys refactor, which requires a path * Fix for resolve_consumer to take in the matrices and right hand sides (#365) * Passing matrices and rhs to resolve_consumer. * Minor typo cuda-->hip * adding generic test matrices * modified numbering to suffix * tests failing with well conditioned matrix * updating to better conditioned matrices * SPD test passes consistently, others don't * still testing * changed matrices * updated matrices * changed test mats * changed matrices * symmetric test passing, asymmetric passing when run separately, but not through make test * changed matrices * changed tolerance to machine precision, tests pass! * Apply pre-commmit fixes * updated consumer * fixed non IR related comments * removed IR check, it passes with IR with the better scaled matrices * Apply pre-commmit fixes * Update tests/functionality/CMakeLists.txt * tests passing * Apply pre-commmit fixes * fixed prints * set convergence conditions * setting convergence condition, but it's overridden * set default to relative residual * added default conv_cond * Apply pre-commmit fixes * Update examples/resolve_consumer/CMakeLists.txt * addressed comment * reverted change that made CI test not pass * made matrices consistent, tolerance too stringent * tests passing, renamed files to be consistent * addressed all comments, only tested on Frontier * addressed comments * removed straggling print --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> Co-authored-by: Nicholson Koukpaizan <72402802+nkoukpaizan@users.noreply.github.com> * Shaked/rework examples csr (#367) * fixed examples * kalmarek example * moved to experimental, kalmarek example works * removed commented code * Apply pre-commmit fixes * Update examples/experimental/CMakeLists.txt * addressed change requests * changed cmake --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Fixed experimental examples to use CSR only. * removed unnecessary Csc reference from examples * removed build files * fixed segfault * fixed glu update * fixed all experimental examples * somehow this segmentation fault fix didn't save * fixed fgmres * Apply pre-commmit fixes * Update examples/experimental/r_KLU_cusolverrf_redo_factorization.cpp * Update examples/experimental/r_KLU_cusolverrf_redo_factorization.cpp * Update examples/experimental/r_KLU_cusolverrf_redo_factorization.cpp --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Fix warning on r_KLU_rocsolverrf_asym6x6 * Fix warning on r_KLU_rocsolverrf_asym6x6. --------- Co-authored-by: nkoukpaizan <nkoukpaizan@users.noreply.github.com> Co-authored-by: Shaked Regev <35384901+shakedregev@users.noreply.github.com> * Removed all CSC code from CSR solvers. (#375) * removed all CSC code * Apply pre-commmit fixes * Update tests/functionality/testRefactor.cpp --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Removed rocSparse "fast" solver from our options (#377) Removed all "fast" solver code. --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Updated changelog and PR template (#381) * Update emails in README.md * Add code of conduct. * Move code of conduct. * Add badges * Change action name to CPU Tests * Update README.md * Add logo to the README file. * Add logo to readthedocs. * Manage images for light/dark schemes in README. * Add logo to Doxygen docs. * Fix path to logo in Doxygen. * Update logos * Add svg logo images. * Update README.md * Update doxygen landing page. * Monor changes to Doxygen landing page * Updated coding and developer guidelines (#242) Added details about implicit coding guidelines that were not specified. Added suggested branching workflow. Added PR reviewing and opening and issue guidelines. Fixed typos Restructured documentation sections Co-authored-by: pelesh <peless@ornl.gov> * Update readthedocs links in README.md Updated links in README to pint to readthedocs pages generated from `frontmatter-dev` branch. This needs to be reverted before merging. * documentation clarification (#267) * fixing typos * fixed typos * Restructured documentation files (#299) --------- Co-authored-by: Adham Ibrahim <37982706+adham-ibrahim7@users.noreply.github.com> Co-authored-by: Slaven Peles <peless@ornl.gov> * Apply pre-commmit fixes * Use Re::Solve instead of ReSolve and update Doxygen logo. * Simplify doxygen stylesheet, allow dark mode * [skip ci] Revert sidebar-only mode. * [skip ci] Another shot on sidebar only doxy theme * ReSolve -> Re::Solve * Apply pre-commmit fixes * Copy Doxyfile.in -> Doxyfile and then modify. * updated contributors * straggling changes * Use correct Doxyfile * Undo doxyfile template changes * rebased frontmatter-dev --------- Co-authored-by: superwhiskers <whiskerdev@protonmail.com> Co-authored-by: Nicholson Koukpaizan <72402802+nkoukpaizan@users.noreply.github.com> Co-authored-by: pelesh <peless@ornl.gov> Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> Co-authored-by: Shaked Regev <shakedvregev@gmail.comregev@gmail.com> Co-authored-by: nkoukpaizan <nkoukpaizan@users.noreply.github.com> Co-authored-by: Adham Ibrahim <37982706+adham-ibrahim7@users.noreply.github.com> Co-authored-by: pelesh <pelesh@users.noreply.github.com>
pelesh
pushed a commit
that referenced
this pull request
Oct 7, 2025
pelesh
added a commit
that referenced
this pull request
Oct 7, 2025
* fix some more memory leaks and add ubsan support to `CMakeLists.txt` (#320) * Fix bug in KLU class affecting non-symmetric linear systems (#323) * Update Spack and setup CI with asan and ubsan variants (#322) * Point Spack to upstream v0.23.1. * Update Frontier modules after Spack upgrade. * Frontier build with +asan+ubsan. * Temporarily point Spack to nkoukpaizan-fork to add asan and ubsan. * +asan+ubsan in GH Actions. * CMake targets for asan and ubsan. * ~asan~ubsan Spack builds on Frontier by default. * Try running CI tests within spack build-env to address the issue of the consumer test not finding the appropriate compiler. * Alias for spack environment in CI. * Revert "Alias for spack environment in CI." This reverts commit fd263ae. * Using `${OLDPWD}` to identify Spack environment. * Add warnings flags to CMake configuration. (#325) --------- Co-authored-by: pelesh <peless@ornl.gov> * fix the means by which cmake finds the suitesparse include dir (#327) * Fixed GLU to work on non-symmetric matrices. Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Synchronize devices after HIP functions (#336) * synchronize devices after HIP functions * Apply pre-commmit fixes * Update resolve/matrix/MatrixHandlerHip.cpp * fixed CUDA * fixed CUDA * Apply pre-commmit fixes * Update resolve/matrix/MatrixHandlerCuda.cpp * Revert "Update resolve/matrix/MatrixHandlerCuda.cpp" This reverts commit 30e41bb. * Revert "Apply pre-commmit fixes" This reverts commit 0bcd8f7. * Revert "fixed CUDA" This reverts commit 62623fa. * Revert "fixed CUDA" This reverts commit b9b249b. --------- Co-authored-by: Shaked Regev <shakedvregev@gmail.comregev@gmail.com> Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Added the ability to reset a workspace without completely destroying it. (#343) * added method to reset workspace * changed tests * added reset workspace to CUDA * now with comments * Apply pre-commmit fixes * Update resolve/workspace/LinAlgWorkspaceCpu.cpp --------- Co-authored-by: Shaked Regev <shakedvregev@gmail.comregev@gmail.com> Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Enforce F being 0 and remove duplicate extract factors code * added check for F!=0 * enforce F being 0 and clean up factor extraction code duplication * Apply pre-commmit fixes * Update resolve/LinSolverDirectKLU.cpp * cleaned up comments * Apply pre-commmit fixes * Update resolve/LinSolverDirectKLU.cpp --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Properly address CSR and CSC discrepancies across all solvers. Fixed discrepancies with minimal overhead. --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> Co-authored-by: pelesh <peless@ornl.gov> * Put sorting within KLU instead of within other solver logic. (#359) * Adding asymmetric tests (from the data folder) for KLU, CuSolver, and RocSolver. (#364) * tests that are supposed to pass are passing * fixed typos, removed unnecessary file * Apply pre-commmit fixes * renamed matrix files (not added before accidentally) * removed commented out code * fixed failing tests * Apply pre-commmit fixes * fixed commented out code * straggling comment * Update tests/functionality/CMakeLists.txt * Update tests/functionality/CMakeLists.txt * Update tests/functionality/CMakeLists.txt * fixed data path for lusol * consumer * fixed typo * changing to sys refactor, which requires a path * Fix for resolve_consumer to take in the matrices and right hand sides (#365) * Passing matrices and rhs to resolve_consumer. * Minor typo cuda-->hip * adding generic test matrices * modified numbering to suffix * tests failing with well conditioned matrix * updating to better conditioned matrices * SPD test passes consistently, others don't * still testing * changed matrices * updated matrices * changed test mats * changed matrices * symmetric test passing, asymmetric passing when run separately, but not through make test * changed matrices * changed tolerance to machine precision, tests pass! * Apply pre-commmit fixes * updated consumer * fixed non IR related comments * removed IR check, it passes with IR with the better scaled matrices * Apply pre-commmit fixes * Update tests/functionality/CMakeLists.txt * tests passing * Apply pre-commmit fixes * fixed prints * set convergence conditions * setting convergence condition, but it's overridden * set default to relative residual * added default conv_cond * Apply pre-commmit fixes * Update examples/resolve_consumer/CMakeLists.txt * addressed comment * reverted change that made CI test not pass * made matrices consistent, tolerance too stringent * tests passing, renamed files to be consistent * addressed all comments, only tested on Frontier * addressed comments * removed straggling print --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> Co-authored-by: Nicholson Koukpaizan <72402802+nkoukpaizan@users.noreply.github.com> * Shaked/rework examples csr (#367) * fixed examples * kalmarek example * moved to experimental, kalmarek example works * removed commented code * Apply pre-commmit fixes * Update examples/experimental/CMakeLists.txt * addressed change requests * changed cmake --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Fixed experimental examples to use CSR only. * removed unnecessary Csc reference from examples * removed build files * fixed segfault * fixed glu update * fixed all experimental examples * somehow this segmentation fault fix didn't save * fixed fgmres * Apply pre-commmit fixes * Update examples/experimental/r_KLU_cusolverrf_redo_factorization.cpp * Update examples/experimental/r_KLU_cusolverrf_redo_factorization.cpp * Update examples/experimental/r_KLU_cusolverrf_redo_factorization.cpp --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Fix warning on r_KLU_rocsolverrf_asym6x6 * Fix warning on r_KLU_rocsolverrf_asym6x6. --------- Co-authored-by: nkoukpaizan <nkoukpaizan@users.noreply.github.com> Co-authored-by: Shaked Regev <35384901+shakedregev@users.noreply.github.com> * Removed all CSC code from CSR solvers. (#375) * removed all CSC code * Apply pre-commmit fixes * Update tests/functionality/testRefactor.cpp --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Removed rocSparse "fast" solver from our options (#377) Removed all "fast" solver code. --------- Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> * Updated changelog and PR template (#381) * Update emails in README.md * Add code of conduct. * Move code of conduct. * Add badges * Change action name to CPU Tests * Update README.md * Add logo to the README file. * Add logo to readthedocs. * Manage images for light/dark schemes in README. * Add logo to Doxygen docs. * Fix path to logo in Doxygen. * Update logos * Add svg logo images. * Update README.md * Update doxygen landing page. * Monor changes to Doxygen landing page * Updated coding and developer guidelines (#242) Added details about implicit coding guidelines that were not specified. Added suggested branching workflow. Added PR reviewing and opening and issue guidelines. Fixed typos Restructured documentation sections Co-authored-by: pelesh <peless@ornl.gov> * Update readthedocs links in README.md Updated links in README to pint to readthedocs pages generated from `frontmatter-dev` branch. This needs to be reverted before merging. * documentation clarification (#267) * fixing typos * fixed typos * Restructured documentation files (#299) --------- Co-authored-by: Adham Ibrahim <37982706+adham-ibrahim7@users.noreply.github.com> Co-authored-by: Slaven Peles <peless@ornl.gov> * Apply pre-commmit fixes * Use Re::Solve instead of ReSolve and update Doxygen logo. * Simplify doxygen stylesheet, allow dark mode * [skip ci] Revert sidebar-only mode. * [skip ci] Another shot on sidebar only doxy theme * ReSolve -> Re::Solve * Apply pre-commmit fixes * Copy Doxyfile.in -> Doxyfile and then modify. * updated contributors * straggling changes * Use correct Doxyfile * Undo doxyfile template changes * rebased frontmatter-dev --------- Co-authored-by: superwhiskers <whiskerdev@protonmail.com> Co-authored-by: Nicholson Koukpaizan <72402802+nkoukpaizan@users.noreply.github.com> Co-authored-by: pelesh <peless@ornl.gov> Co-authored-by: shakedregev <shakedregev@users.noreply.github.com> Co-authored-by: Shaked Regev <shakedvregev@gmail.comregev@gmail.com> Co-authored-by: nkoukpaizan <nkoukpaizan@users.noreply.github.com> Co-authored-by: Adham Ibrahim <37982706+adham-ibrahim7@users.noreply.github.com> Co-authored-by: pelesh <pelesh@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Clarified when full documentation can be skipped for functions.
Proposed changes
Codifies the implicit assumption in the code vase that trivial function do not require documentation.
Checklist
N/A - documentation only
-Wall -Wpedantic -Wconversion -Wextra.Further comments
If this is a relatively large or complex change, kick off the discussion by explaining
why you chose the solution you did and what alternatives you considered, etc.