docs: spell out kactl macros in doc comments#233
Merged
Conversation
2c5d0d2 to
4a45aae
Compare
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.
The main branch publishes headers with kactl macros expanded (
update_main.shruns them throughcppwithkactl_macros.hpp), but doc comments pass through the preprocessor untouched — so on main, docstrings referencedvi,pii,ll,sz(...), andrep(...)while the surrounding code showed the expanded forms.This spells out the macros in all doc comments so the published docstrings match the published code:
vi→vector<int>pii→pair<int, int>ll→int64_tsz(x)→ssize(x)rep(i, a, b)→for (int i = a; i < b; i++)Deliberately untouched:
vl/vrinseg_tree.hpp/merge_sort_tree.hpp(variables, not macros)vlinwildcard_pattern_matching.hppdocs (that file definesusing vl = vector<ll>;in code, which survives to main)Comment-only change: 41 files, all 64 changed diff lines are comments; zero code lines touched. Lines that exceeded the 59-column limit after expansion were re-wrapped. clang-format (
dev.clang-format) passes on all changed files, and a repo-wide scan confirms no macro tokens remain in any library comment.