docs(sdk): fix fr_sk_ key format in core.py + instruments.py docstrings - #60
Merged
Conversation
Extends the README fix to the in-code docstring examples (rendered in help()/IDE hovers), which still showed api_key="fr-xxx". Real keys are fr_sk_<token>. First-party code only — no _vendor/ changes, so no re-vendoring needed per internal-sop VENDORING_SOP.md. - core.py: 10 occurrences (init() + configure() fluent-API examples) - instruments.py: 2 occurrences
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.
What & why
Follow-up to #58 (which fixed the README). The in-code docstring examples in
core.py(init()+configure()fluent API) andinstruments.pystill showedapi_key="fr-xxx", which is not a valid key format — real keys arefr_sk_<token>(minted byGenerateAPIKey()/ validated by ingestion auth). These docstrings render inhelp()and IDE hovers, so they mislead exactly where developers look.Changes
core.py: 10 occurrencesfr-xxx->fr_sk_...instruments.py: 2 occurrencesScope / safety
_vendor/changes, so no re-vendoring needed (perinternal-sop/openllmetry/VENDORING_SOP.md, vendoring governs only_vendor/;core.py/instruments.pyare first-party).fr-xxx.