Sync internal settings documentation with header definitions#453
Draft
Sync internal settings documentation with header definitions#453
Conversation
Co-authored-by: atlnz-scottp <239511521+atlnz-scottp@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Check for inconsistencies between documentation and implementation
Sync internal settings documentation with header definitions
Feb 7, 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.
README.md listed 7 internal settings paths while apteryx.h defines 10, causing documentation drift.
Changes
/apteryx/refreshers- refresh callback registrations/apteryx/indexers- index callback registrations/apteryx/statistics- callback usage metricsThese paths correspond to the REFRESH and INDEX APIs already documented in both files but were omitted from the internal settings section.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.