Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: make errors more readable with Display impls #1597

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Conversation

ss2165
Copy link
Member

@ss2165 ss2165 commented Oct 18, 2024

Particularly useful for cli validation errors.

  • Blanket Display for OpType that uses name, can be made more specific in future.
  • user derive_more::Display in more places

Particularly useful for cli validation errors.

- Blanket Display for OpType that uses name, can be made more specific in future.
- user derive_more::Display in more places
@ss2165 ss2165 requested a review from a team as a code owner October 18, 2024 13:25
@ss2165 ss2165 requested a review from cqc-alec October 18, 2024 13:25
Copy link

codecov bot commented Oct 18, 2024

Codecov Report

Attention: Patch coverage is 19.04762% with 17 lines in your changes missing coverage. Please review.

Project coverage is 85.72%. Comparing base (6097391) to head (79c58a0).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
hugr-core/src/hugr/validate/test.rs 0.00% 5 Missing ⚠️
hugr-core/src/core.rs 0.00% 3 Missing ⚠️
hugr-core/src/ops.rs 0.00% 3 Missing ⚠️
hugr-core/src/hugr/rewrite/replace.rs 0.00% 1 Missing ⚠️
hugr-core/src/hugr/validate.rs 0.00% 1 Missing ⚠️
hugr-core/src/import.rs 0.00% 1 Missing ⚠️
hugr-core/src/types.rs 0.00% 1 Missing ⚠️
hugr-core/src/utils.rs 0.00% 1 Missing ⚠️
hugr-passes/src/const_fold/test.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1597      +/-   ##
==========================================
- Coverage   85.75%   85.72%   -0.04%     
==========================================
  Files         136      136              
  Lines       24773    24783      +10     
  Branches    21709    21719      +10     
==========================================
  Hits        21244    21244              
- Misses       2427     2437      +10     
  Partials     1102     1102              
Flag Coverage Δ
python 92.68% <ø> (ø)
rust 84.73% <19.04%> (-0.04%) ⬇️

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.

Copy link
Collaborator

@cqc-alec cqc-alec left a comment

Choose a reason for hiding this comment

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

Thanks!

@ss2165 ss2165 added this pull request to the merge queue Oct 18, 2024
Merged via the queue into main with commit c79b95b Oct 18, 2024
20 of 21 checks passed
@ss2165 ss2165 deleted the feat/simple-err branch October 18, 2024 13:38
@hugrbot hugrbot mentioned this pull request Oct 18, 2024
github-merge-queue bot pushed a commit that referenced this pull request Oct 22, 2024
## 🤖 New release
* `hugr`: 0.13.1 -> 0.13.2 (✓ API compatible changes)
* `hugr-core`: 0.13.1 -> 0.13.2 (✓ API compatible changes)
* `hugr-model`: 0.13.1 -> 0.13.2 (✓ API compatible changes)
* `hugr-passes`: 0.13.1 -> 0.13.2 (✓ API compatible changes)
* `hugr-cli`: 0.13.1 -> 0.13.2 (✓ API compatible changes)

<details><summary><i><b>Changelog</b></i></summary><p>

## `hugr`
<blockquote>

##
[0.13.2](hugr-v0.13.1...hugr-v0.13.2)
- 2024-10-22

### Bug Fixes

- Allocate ports on root nodes
([#1585](#1585))

### New Features

- Render function names in `mermaid`/`dot`
([#1583](#1583))
- Add filter_edge_kind to PortIterator
([#1593](#1593))
- make errors more readable with Display impls
([#1597](#1597))
- Ensure packages always have modules at the root
([#1589](#1589))
- Add `Package` definition on `hugr-core`
([#1587](#1587))
</blockquote>

## `hugr-core`
<blockquote>

##
[0.13.2](hugr-core-v0.13.1...hugr-core-v0.13.2)
- 2024-10-22

### Bug Fixes

- Allocate ports on root nodes
([#1585](#1585))

### New Features

- Add `Package` definition on `hugr-core`
([#1587](#1587))
- Render function names in `mermaid`/`dot`
([#1583](#1583))
- Add filter_edge_kind to PortIterator
([#1593](#1593))
- make errors more readable with Display impls
([#1597](#1597))
- Ensure packages always have modules at the root
([#1589](#1589))
</blockquote>

## `hugr-model`
<blockquote>

##
[0.13.2](hugr-model-v0.13.1...hugr-model-v0.13.2)
- 2024-10-22

### New Features

- make errors more readable with Display impls
([#1597](#1597))
</blockquote>

## `hugr-passes`
<blockquote>

##
[0.13.2](hugr-passes-v0.13.1...hugr-passes-v0.13.2)
- 2024-10-22

### New Features

- make errors more readable with Display impls
([#1597](#1597))
</blockquote>

## `hugr-cli`
<blockquote>

##
[0.13.2](hugr-cli-v0.13.1...hugr-cli-v0.13.2)
- 2024-10-22

### New Features

- Add `Package` definition on `hugr-core`
([#1587](#1587))
- Ensure packages always have modules at the root
([#1589](#1589))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).
@hugrbot hugrbot mentioned this pull request Oct 29, 2024
github-merge-queue bot pushed a commit that referenced this pull request Nov 6, 2024
## 🤖 New release
* `hugr`: 0.13.2 -> 0.13.3 (✓ API compatible changes)
* `hugr-core`: 0.13.2 -> 0.13.3 (✓ API compatible changes)
* `hugr-model`: 0.13.2 -> 0.14.0 (⚠️ API breaking changes)
* `hugr-passes`: 0.13.2 -> 0.13.3
* `hugr-cli`: 0.13.2 -> 0.13.3

### ⚠️ `hugr-model` breaking changes

```
--- failure enum_variant_added: enum variant added on exhaustive enum ---

Description:
A publicly-visible enum without #[non_exhaustive] has a new variant.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.36.0/src/lints/enum_variant_added.ron

Failed in:
  variant RegionKind:Module in /tmp/.tmpL1Ich1/hugr/hugr-model/src/v0/mod.rs:390
  variant Operation:DeclareConstructor in /tmp/.tmpL1Ich1/hugr/hugr-model/src/v0/mod.rs:349
  variant Operation:DeclareOperation in /tmp/.tmpL1Ich1/hugr/hugr-model/src/v0/mod.rs:357
```

<details><summary><i><b>Changelog</b></i></summary><p>

## `hugr`
<blockquote>

##
[0.13.3](hugr-v0.13.2...hugr-v0.13.3)
- 2024-11-06

### Bug Fixes

- Insert DFG directly as a funcdefn in `Package::from_hugr`
([#1621](#1621))

### New Features

- `HugrMut::remove_metadata`
([#1619](#1619))
- Operation and constructor declarations in `hugr-model`
([#1605](#1605))
- Add TailLoop::BREAK_TAG and CONTINUE_TAG
([#1626](#1626))
</blockquote>

## `hugr-core`
<blockquote>

##
[0.13.3](hugr-core-v0.13.2...hugr-core-v0.13.3)
- 2024-11-06

### Bug Fixes

- Insert DFG directly as a funcdefn in `Package::from_hugr`
([#1621](#1621))

### New Features

- `HugrMut::remove_metadata`
([#1619](#1619))
- Operation and constructor declarations in `hugr-model`
([#1605](#1605))
- Add TailLoop::BREAK_TAG and CONTINUE_TAG
([#1626](#1626))
</blockquote>

## `hugr-model`
<blockquote>

##
[0.14.0](hugr-model-v0.13.2...hugr-model-v0.14.0)
- 2024-11-06

### New Features

- Operation and constructor declarations in `hugr-model`
([#1605](#1605))
</blockquote>

## `hugr-passes`
<blockquote>

##
[0.13.2](hugr-passes-v0.13.1...hugr-passes-v0.13.2)
- 2024-10-22

### New Features

- make errors more readable with Display impls
([#1597](#1597))
</blockquote>

## `hugr-cli`
<blockquote>

##
[0.13.2](hugr-cli-v0.13.1...hugr-cli-v0.13.2)
- 2024-10-22

### New Features

- Add `Package` definition on `hugr-core`
([#1587](#1587))
- Ensure packages always have modules at the root
([#1589](#1589))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).
@hugrbot hugrbot mentioned this pull request Nov 8, 2024
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