Skip to content

Added basic bug hunting documentation#1077

Merged
jacobcook1995 merged 13 commits intofeature/docs-ui-updatefrom
feature/litter_bug_hunting_docs
Mar 31, 2026
Merged

Added basic bug hunting documentation#1077
jacobcook1995 merged 13 commits intofeature/docs-ui-updatefrom
feature/litter_bug_hunting_docs

Conversation

@jacobcook1995
Copy link
Copy Markdown
Collaborator

@jacobcook1995 jacobcook1995 commented Oct 7, 2025

Description

This PR adds simplified versions of the bug hunting/squashing notebooks that @LingdaLu developed as part of her UROP project.

I haven't written much superstructure, and I think we still need to decide the best way to include Jupyter notebooks, so I'm submitting this as a draft.

Feedback on what's being plotted in the notebooks is also very welcome (think I've become sufficiently used to staring at this kind of plot to be basically blind to possible improvements)

I'm also aware that the second notebook is very messy due to the divide by zero warnings, I'm planning to wait until #1006 (which fixes that issue) is merged and then rerun the notebook.

The docs associated with this PR can be found here

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works
  • Relevant documentation reviewed and updated

…ng her UROP project to the docs

Co-Authored-By: Lingda Lu <151921362+LingdaLu@users.noreply.github.com>
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Oct 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.10%. Comparing base (7f9193c) to head (0830ee5).

Additional details and impacted files
@@                   Coverage Diff                   @@
##           feature/docs-ui-update    #1077   +/-   ##
=======================================================
  Coverage                   94.10%   94.10%           
=======================================================
  Files                          72       72           
  Lines                        7604     7604           
=======================================================
  Hits                         7156     7156           
  Misses                        448      448           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

@jacobcook1995 jacobcook1995 changed the base branch from develop to feature/docs-ui-update February 5, 2026 10:31
@jacobcook1995 jacobcook1995 force-pushed the feature/litter_bug_hunting_docs branch from 495a4dc to 6892c3e Compare February 19, 2026 14:09
@jacobcook1995 jacobcook1995 marked this pull request as ready for review February 23, 2026 08:39
@jacobcook1995
Copy link
Copy Markdown
Collaborator Author

@davidorme I've integrated your debugging notes in here and added an over arching section to link it with Lingda's work. Let me know whether it all looks okay to you, or if there's anything I should change!

Copy link
Copy Markdown
Collaborator

@davidorme davidorme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - sorry for the slow 👍

@jacobcook1995 jacobcook1995 enabled auto-merge March 31, 2026 10:08
@jacobcook1995 jacobcook1995 merged commit 53aa75a into feature/docs-ui-update Mar 31, 2026
13 checks passed
@jacobcook1995 jacobcook1995 deleted the feature/litter_bug_hunting_docs branch March 31, 2026 10:23
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.

3 participants