Skip to content

Streamline README and move long usage notes into docs#435

Open
Erotemic wants to merge 2 commits into
pyutils:mainfrom
Erotemic:update-readme
Open

Streamline README and move long usage notes into docs#435
Erotemic wants to merge 2 commits into
pyutils:mainfrom
Erotemic:update-readme

Conversation

@Erotemic

@Erotemic Erotemic commented Jul 4, 2026

Copy link
Copy Markdown
Member

The current README is too long. This is a move to a shorter README while keeping the old one for now. The idea is that things from the legacy README should move into a proper place in the docs over time, but for now nothing is lost on the public facing code, and it pushes a cleaner first impression now, and lets us decide what that logical docs split is later.

@codecov

codecov Bot commented Jul 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.40%. Comparing base (c2a6a30) to head (5d0ee19).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #435      +/-   ##
==========================================
+ Coverage   82.38%   82.40%   +0.01%     
==========================================
  Files          20       20              
  Lines        2254     2256       +2     
  Branches      359      359              
==========================================
+ Hits         1857     1859       +2     
  Misses        300      300              
  Partials       97       97              
Files with missing lines Coverage Δ
...ne_profiler/autoprofile/ast_profile_transformer.py 47.72% <ø> (ø)
line_profiler/autoprofile/line_profiler_utils.py 52.94% <ø> (ø)
line_profiler/cli_utils.py 89.89% <ø> (ø)
line_profiler/ipython_extension.py 98.19% <ø> (ø)
line_profiler/line_profiler.py 95.77% <ø> (ø)

... and 2 files with indirect coverage changes


Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a5ec7fd...5d0ee19. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant