Review and consolidate docs/ into README - #1
Open
ohowell-kx wants to merge 2 commits into
Open
ohowell-kx wants to merge 2 commits into
ohowell-kx wants to merge 2 commits into
Conversation
Merge docs/reference.md and docs/install.md into the README and delete the separate files. For a project exposing three q functions, the indirection cost more than it gave: the README was little more than a pair of links, and nothing consumed docs/ (no docs site config, no CI, no frontmatter). Rewrite the API reference from src/ rather than copying it. The old version gave one sentence per function and documented none of the actual contract. It now covers the loglevel option and its seven values, the boolean returns from initialize/shutDown, the 'type/'loglevel/'uninitialized errors, the five-key credentials dictionary with expiration as epoch millis, the atexit handler, and the fact that credentials are not cached. Document the AWS SDK for C++ shared libraries as a runtime prerequisite. The release archives ship only the module binary, so installing a release without the libraries present fails at load with a 'no kexport error. This was previously mentioned only under the from-source path, and LD_LIBRARY_PATH was framed as a build-time note. Also fix the authentiaction and Afer typos, fill in the placeholder repo URL in the from-source clone step, and tag the untagged unzip code fence. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Verified the API reference by running the module. Two claims were wrong: The expiration example showed a plausible near-future timestamp, but credentials that do not expire report 9223372036854 -- the largest value a millisecond timestamp can hold, which renders as 2262.04.11D23:47:16.854. Document the sentinel and use the real value in the example. A chain that resolves nothing is not an error. getCredentials still succeeds and returns all five keys with empty strings, so callers must check the result rather than rely on a signal. This was undocumented. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.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
1 participant
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.
Merge docs/reference.md and docs/install.md into the README and delete the separate files. For a project exposing three q functions, the indirection cost more than it gave: the README was little more than a pair of links, and nothing consumed docs/ (no docs site config, no CI, no frontmatter).
Rewrite the API reference from src/ rather than copying it. The old version gave one sentence per function and documented none of the actual contract. It now covers the loglevel option and its seven values, the boolean returns from initialize/shutDown, the 'type/'loglevel/'uninitialized errors, the five-key credentials dictionary with expiration as epoch millis, the atexit handler, and the fact that credentials are not cached.
Document the AWS SDK for C++ shared libraries as a runtime prerequisite. The release archives ship only the module binary, so installing a release without the libraries present fails at load with a 'no kexport error. This was previously mentioned only under the from-source path, and LD_LIBRARY_PATH was framed as a build-time note.
Also fix the authentiaction and Afer typos, fill in the placeholder repo URL in the from-source clone step, and tag the untagged unzip code fence.