Update great-docs.yml config - #50
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Add auto_include: [core] so analytics functions in tidyfinance.core are documented (Great Docs auto-excludes the 'core' module name). - Stop leaking import helpers, discovery loop variables, and toggle constants from tidyfinance/__init__.py into the public namespace. - Make the backend wrapper private (use_backend -> _use_backend) so it no longer appears in the public API or Reference page. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Convert doctest-style (>>> / ...) Examples blocks to fenced python code blocks across all modules. Great Docs' copy button copied the prompts verbatim, so pasted examples were not runnable. The examples contained no expected-output lines, so no doctest coverage is lost. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Document the auto-discovered public API, the fenced-code-block docstring example convention (no >>> doctest prompts), the Great Docs 'core' auto_include caveat, and common uv/pytest/great-docs commands. Co-Authored-By: Claude Opus 4.8 <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.
Summary
module: tidyfinanceso docs resolve the correct importable module name🤖 Generated with Claude Code