Skip to content

docs: link hugr-py docs from root README, update copyright#2881

Open
CalMacCQ wants to merge 3 commits intomainfrom
cm/py_docs_link
Open

docs: link hugr-py docs from root README, update copyright#2881
CalMacCQ wants to merge 3 commits intomainfrom
cm/py_docs_link

Conversation

@CalMacCQ
Copy link
Contributor

@CalMacCQ CalMacCQ commented Feb 17, 2026

Adding a link to the HUGR py docs from the README of this repo.

Driveby: fix the out of date copyright. I've used datetime to fix the year rather than hardcoding the value.

@CalMacCQ CalMacCQ requested a review from a team as a code owner February 17, 2026 10:14
@CalMacCQ CalMacCQ requested a review from doug-q February 17, 2026 10:14
@codecov
Copy link

codecov bot commented Feb 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.80%. Comparing base (82c25ef) to head (4a24198).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2881   +/-   ##
=======================================
  Coverage   83.80%   83.80%           
=======================================
  Files         267      267           
  Lines       53605    53606    +1     
  Branches    47731    47731           
=======================================
+ Hits        44926    44927    +1     
  Misses       6272     6272           
  Partials     2407     2407           
Flag Coverage Δ
python 88.47% <100.00%> (+<0.01%) ⬆️
rust 83.23% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@CalMacCQ CalMacCQ requested review from aborgna-q and removed request for doug-q February 17, 2026 10:20
Copy link
Collaborator

@aborgna-q aborgna-q Feb 17, 2026

Choose a reason for hiding this comment

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

This is the README that appears in the crates.io page for the rust library.

The root README is currently symlinked to this, but I think we should make a copy instead, and add the python docs link there (as well as update it to talk about the different libraries, but that can be done later).

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.

2 participants