Repository navigation
Fix compilation of README and ExternalProject examples - #336
Open
dajiaohuang wants to merge 1 commit into
Open
dajiaohuang wants to merge 1 commit into
dajiaohuang wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The three focused documentation fixes match the library API and header layout, with no unresolved issues.
0 open findings
What changed in this PR
Corrects three compilation errors in documented consumer examples without changing library behavior or compiler requirements.
Changes:
- Fixes the README’s
mainreturn type andnumberstemplate arguments. - Points the ExternalProject consumer at the repository’s
includedirectory.
| File | Description |
|---|---|
| README.md | Corrects the cat and Collatz examples. |
| INSTALL.md | Fixes the ExternalProject include path. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Dobiasd
approved these changes
Oct 18, 2026
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
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.
Summary
Fix three compilation errors in the documented consumer examples:
int main()in the README's cat example (GCC rejectsvoid main()).numbers<int, Ints>(1, 30), matching the publicnumberstemplate signature.numbers<Ints>treats the list type as the numeric element type and does not compile./includeto the ExternalProject example's include directory, so<fplus/fplus.hpp>can be found in the downloaded repository.No library behavior or compiler requirements change.
Validation
Tested with GCC 13.3.0,
-std=c++14, and CMake 3.28.3 on Ubuntu 24.04:std::list<int> collatz_seq(int)implementation used intest/readme_examples_test.cpp.<fplus/fplus.hpp>.find_package(FunctionalPlus)consumer.git diff --checkpasses.The full upstream test suite and other compiler/platform/package-manager matrices were not run; this change only corrects documentation examples.