Correct the README project-structure tree - #89
Open
tschm wants to merge 1 commit into
Open
Conversation
The tree showed src/core/, src/data/, src/api/ and src/web/, but the packages live under src/pycharting/. It also listed a top-level data/ directory for "sample CSVs and fixtures" that does not exist, and omitted docs/, which does. The fence carried no language tag, so nothing could check it. Tagging it text clears the last untagged fence reported by check_doc_examples.py. Closes alihaskar#85 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the README’s “Project structure” section so it accurately reflects the repository’s actual src/ layout and documentation directories, aligning the diagram with the surrounding text and documentation tooling expectations.
Changes:
- Corrected the tree to show packages under
src/pycharting/rather than directly undersrc/. - Removed the non-existent top-level
data/entry and added the existingdocs/directory. - Added a language tag (
text) to the fenced tree block so doc tooling can validate it.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Closes #85
Problem
The "Project structure" tree described a layout the repo does not have:
src/core/,src/data/,src/api/,src/web/, but the packages live undersrc/pycharting/. The section's own opening line ("The library follows a modernsrc/layout") was right; the tree contradicted it.data/ # Sample CSVs and fixturesdirectory that does not exist.docs/, which does exist and holdshow-it-works.md— linked from the paragraph immediately above.The fence also carried no language tag, so no tooling could check it:
Change
The tree now reflects the real layout, drops the non-existent
data/, addsdocs/, and is tagged```text.Verification
check_doc_examples.py --source-root src— no untagged fences remainmake fmt— markdownlint clean🤖 Generated with Claude Code