docs(ai): add active-development caution to AI package entry point#195
Open
tmgbedu wants to merge 1 commit into
Open
docs(ai): add active-development caution to AI package entry point#195tmgbedu wants to merge 1 commit into
tmgbedu wants to merge 1 commit into
Conversation
Add a module-level docstring warning to the AI package's __init__ noting the package is under active development, that APIs may change without notice, and that it should be used with caution in production.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
Adds a module-level caution notice to the AI package's entry point (
src/fastapi_startkit/ai/__init__.py), stating the package is under active development, may introduce breaking changes, and the team is still experimenting with the best integration approach. Documentation-only — no functional code changes. (task #1235)Change
Module docstring added at the top of
fastapi_startkit/ai/__init__.py:Placed as a proper module docstring (reST
.. warning::admonition) so it surfaces in IDE hovers and any generated API docs.Verification
ruff checkandruff format --checkpass on the file.ast.get_docstring→ present).The companion docs-site callouts are in a separate PR against the
fastapi-startkit.github.iorepo.