Repository navigation
feat: typespecs for the public API, Dialyzer in CI, doctests, grouped docs - #6
Merged
Merged
Conversation
… docs - SystemOneClient.option/0, options/0, error/0, questions/0 and Provider.name/0 types; specs on both evaluate/3 implementations and on Provider.resolve/1, all checked by Dialyzer with :unmatched_returns, :error_handling, :extra_return and :missing_return (0 errors) - Dialyzer runs in the CI lint job with a cached PLT (priv/plts, ignored) - 8 doctests on the pure functions, run from test/system_one_client/doctest_test.exs - ex_doc groups modules into Client, Providers, Answers and Testing Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GCRzC1xV9gCW4bf7LzBGcB
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GCRzC1xV9gCW4bf7LzBGcB
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.
Stacked on #5 (which is stacked on #2). Merge order: #2, #5, then this. GitHub retargets each to
mainas the one below it merges.Types and specs
SystemOneClient.option/0andoptions/0(every optionevaluate/3accepts),error/0(every errorSystemOneClient.HTTPreturns),questions/0,question_id/0, andSystemOneClient.Provider.name/0.evaluate/3implementations and onProvider.resolve/1; the behaviour callback uses the new types.:unmatched_returns,:error_handling,:extra_returnand:missing_return: 0 errors. It runs in the CI lint job with a cached PLT inpriv/plts, which is git-ignored.Docs
validate_questions/1,Answer.parse/1,Provider.resolve/1, the OpenAI request encoder). They run inmix testand show as examples on hexdocs.Verified locally
63 tests (55 plus 8 doctests), Dialyzer in dev and test,
credo --strict, format, warnings-as-errors,docs --warnings-as-errors.🤖 Generated with Claude Code
https://claude.ai/code/session_01GCRzC1xV9gCW4bf7LzBGcB