Skip to content

Add cycle closure docs - #224

Merged
jthorton merged 6 commits into
mainfrom
cce_docs
Jun 17, 2026
Merged

Add cycle closure docs#224
jthorton merged 6 commits into
mainfrom
cce_docs

Conversation

@jthorton

@jthorton jthorton commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Description

Provide a brief description of the PR's purpose here.
Drafted by me and cleaned with GPT5
Fixes #221

Todos

Notable points that this PR has either accomplished or will accomplish.

  • TODO 1

Questions

  • Question1

Checklist

  • Added a news entry for new features, bug fixes, or other user facing changes.

Status

  • Ready to go

Tips

  • Comment "pre-commit.ci autofix" to have pre-commit.ci atomically format your PR.
    Since this will create a commit, it is best to make this comment when you are finished with your work.

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@jthorton

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@jthorton jthorton self-assigned this Jun 16, 2026
@codecov

codecov Bot commented Jun 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.53%. Comparing base (7a5d72f) to head (5c8092d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #224   +/-   ##
=======================================
  Coverage   97.53%   97.53%           
=======================================
  Files          22       22           
  Lines        2470     2470           
=======================================
  Hits         2409     2409           
  Misses         61       61           

☔ View full report in Codecov by Harness.
📢 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.

@jthorton

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@IAlibay

IAlibay commented Jun 17, 2026

Copy link
Copy Markdown
Member

I had a very brief look through and it looks good. I'll let @hannahbaumann do the real review though.

@@ -0,0 +1,3614 @@
{

@hannahbaumann hannahbaumann Jun 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

values should be close to zero.

Maybe just "should be zero" since that's what you would expect with perfect sampling (from a theoretical standpoint)?

Note Not all 

[nit] Note:


Reply via ReviewNB

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks changed to "should be zero (assuming perfect sampling)."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed "Note:"

@hannahbaumann hannahbaumann left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @jthorton , lgtm, just left the two small comments!

@jthorton
jthorton merged commit c91f57d into main Jun 17, 2026
8 checks passed
@jthorton
jthorton deleted the cce_docs branch June 17, 2026 09:07
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.

Add docs for the cycle closure methods

3 participants