Summary of Issues Found in PR #2
This issue tracks several code quality problems identified during the review of the v0.1.0 release:
1. CMAKE_CURRENT_BINAYR_DIR Typo 馃悰
- File:
doc/_static/images/CMakeLists.txt
- Issue: Misspelled CMake variable name
CMAKE_CURRENT_BINAYR_DIR instead of CMAKE_CURRENT_BINARY_DIR
- Impact: This could cause build failures or incorrect file paths
2. DoxygenLayout.xml Filename Issue 馃搧
- File:
doxygen/DoxygenLayout.xml
- Issue: The file is named
DxygenLayout.xml (missing 'o' in 'Doxygen')
- Impact: Could cause documentation generation issues
3. Unsafe Identifiers::back() Implementation 鈿狅笍
- File:
include/cpp_common/identifiers.hpp
- Issue: The
back() method uses *m_ids.end() which is undefined behavior for empty containers
- Impact: Potential runtime crashes when calling
back() on empty Identifiers
4. Documentation Typo: 'Discurse' 馃摑
- File:
doc/general/support.rst
- Issue: Header says "Discurse" instead of "Discourse"
- Impact: Minor documentation quality issue
5. Potential Memory Management Concerns 馃攳
- Areas: Various C++ headers mixing PostgreSQL memory management with standard C++
- Issue: Need to ensure consistent use of PostgreSQL's memory allocation functions
- Impact: Could lead to memory leaks or crashes
Recommendations
Related: PR #2
Requester: @cvvergara
Summary of Issues Found in PR #2
This issue tracks several code quality problems identified during the review of the v0.1.0 release:
1. CMAKE_CURRENT_BINAYR_DIR Typo 馃悰
doc/_static/images/CMakeLists.txtCMAKE_CURRENT_BINAYR_DIRinstead ofCMAKE_CURRENT_BINARY_DIR2. DoxygenLayout.xml Filename Issue 馃搧
doxygen/DoxygenLayout.xmlDxygenLayout.xml(missing 'o' in 'Doxygen')3. Unsafe Identifiers::back() Implementation鈿狅笍
include/cpp_common/identifiers.hppback()method uses*m_ids.end()which is undefined behavior for empty containersback()on empty Identifiers4. Documentation Typo: 'Discurse' 馃摑
doc/general/support.rst5. Potential Memory Management Concerns 馃攳
Recommendations
Related: PR #2
Requester: @cvvergara