docs: Add usage info to hugr-cli's rustdocs #2044
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2044 +/- ##
=======================================
Coverage 83.09% 83.09%
=======================================
Files 215 215
Lines 40905 40905
Branches 37119 37119
=======================================
Hits 33992 33992
Misses 5027 5027
Partials 1886 1886
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
qartik
approved these changes
Apr 1, 2025
|
I wonder if there's a way to extract the docstring from the |
|
It's not a straight dump, as there's some markdown formatting around it. |
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Apr 2, 2025
## 🤖 New release
* `hugr-model`: 0.18.1 -> 0.19.0 (⚠ API breaking changes)
* `hugr-core`: 0.15.2 -> 0.15.3 ~(⚠ API breaking changes)~
* `hugr-llvm`: 0.15.2 -> 0.15.3 (✓ API compatible changes)
* `hugr-passes`: 0.15.2 -> 0.15.3 (✓ API compatible changes)
* `hugr`: 0.15.2 -> 0.15.3 (✓ API compatible changes)
* `hugr-cli`: 0.15.2 -> 0.15.3 (✓ API compatible changes)
### ⚠ `hugr-model` breaking changes
```text
--- failure enum_missing: pub enum removed or renamed ---
Description:
A publicly-visible enum cannot be imported by its prior path. A `pub use` may have been removed, or the enum itself may have been renamed or removed entirely.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_missing.ron
Failed in:
enum hugr_model::v0::table::ExtSetPart, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:352
--- 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.40.0/src/lints/enum_variant_added.ron
Failed in:
variant Term:Func in /tmp/.tmpIpZPlW/hugr/hugr-model/src/v0/table/mod.rs:341
--- failure enum_variant_missing: pub enum variant removed or renamed ---
Description:
A publicly-visible enum has at least one variant that is no longer available under its prior name. It may have been renamed or removed entirely.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_variant_missing.ron
Failed in:
variant Term::ExtSet, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:316
variant Term::ConstFunc, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:321
variant Term::ExtSet, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/ast/mod.rs:237
--- failure pub_module_level_const_missing: pub module-level const is missing ---
Description:
A public const is missing or renamed
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/pub_module_level_const_missing.ron
Failed in:
CORE_EXT_SET in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/mod.rs:177
```
### ⚠ `hugr-core` breaking changes (⚠️ ignored ⚠️ )
```text
--- 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.40.0/src/lints/enum_variant_added.ron
Failed in:
variant ImportError:OrderHint in /tmp/.tmpIpZPlW/hugr/hugr-core/src/import.rs:73
```
<details><summary><i><b>Changelog</b></i></summary><p>
## `hugr-model`
<blockquote>
##
[0.19.0](hugr-model-v0.18.1...hugr-model-v0.19.0)
- 2025-04-02
### New Features
- Python bindings for `hugr-model`.
([#1959](#1959))
- Remove extension sets from `hugr-model`.
([#2031](#2031))
- Packages in `hugr-model` and envelope support.
([#2026](#2026))
- Represent order edges in `hugr-model` as metadata.
([#2027](#2027))
</blockquote>
## `hugr-core`
<blockquote>
##
[0.16.0](hugr-core-v0.15.2...hugr-core-v0.16.0)
- 2025-04-02
### Documentation
- Provide docs for array ops, fix bad doc for HugrView::poly_func_type
([#2021](#2021))
### New Features
- Expand SimpleReplacement API
([#1920](#1920))
- Python bindings for `hugr-model`.
([#1959](#1959))
- ReplaceTypes pass allows replacing extension types and ops
([#1989](#1989))
- Remove extension sets from `hugr-model`.
([#2031](#2031))
- Packages in `hugr-model` and envelope support.
([#2026](#2026))
- Represent order edges in `hugr-model` as metadata.
([#2027](#2027))
- add `build_expect_sum` to allow specific error messages
([#2032](#2032))
</blockquote>
## `hugr-llvm`
<blockquote>
##
[0.16.0](hugr-llvm-v0.15.2...hugr-llvm-v0.16.0)
- 2025-04-02
### New Features
- *(hugr-llvm)* Add llvm codegen for `arithmetic.float.fpow`
([#2042](#2042))
- *(hugr-llvm)* Emit divmod and mod operations
([#2025](#2025))
</blockquote>
## `hugr-passes`
<blockquote>
##
[0.16.0](hugr-passes-v0.15.2...hugr-passes-v0.16.0)
- 2025-04-02
### New Features
- ReplaceTypes pass allows replacing extension types and ops
([#1989](#1989))
- MakeTuple->UnpackTuple elision pass
([#2012](#2012))
- [**breaking**] Extend LowerTypes pass to linearize by inserting
copy/discard ([#2018](#2018))
</blockquote>
## `hugr`
<blockquote>
##
[0.16.0](hugr-v0.15.2...hugr-v0.16.0)
- 2025-04-02
### Documentation
- Provide docs for array ops, fix bad doc for HugrView::poly_func_type
([#2021](#2021))
### New Features
- MakeTuple->UnpackTuple elision pass
([#2012](#2012))
- [**breaking**] Extend LowerTypes pass to linearize by inserting
copy/discard ([#2018](#2018))
- Expand SimpleReplacement API
([#1920](#1920))
- Python bindings for `hugr-model`.
([#1959](#1959))
- ReplaceTypes pass allows replacing extension types and ops
([#1989](#1989))
- Remove extension sets from `hugr-model`.
([#2031](#2031))
- Represent order edges in `hugr-model` as metadata.
([#2027](#2027))
- add `build_expect_sum` to allow specific error messages
([#2032](#2032))
- Packages in `hugr-model` and envelope support.
([#2026](#2026))
</blockquote>
## `hugr-cli`
<blockquote>
##
[0.16.0](hugr-cli-v0.15.2...hugr-cli-v0.16.0)
- 2025-04-02
### Documentation
- Add usage info to hugr-cli's rustdocs
([#2044](#2044))
</blockquote>
</p></details>
---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).
---------
Co-authored-by: Agustín Borgna <agustin.borgna@quantinuum.com>
Closed
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
May 7, 2025
## 🤖 New release
* `hugr-model`: 0.19.0 -> 0.19.1 (✓ API compatible changes)
* `hugr-core`: 0.15.3 -> 0.15.4 (✓ API compatible changes)
* `hugr-llvm`: 0.15.3 -> 0.15.4 (~⚠ API breaking changes~ overwriten)
* `hugr-passes`: 0.15.3 -> 0.15.4 (✓ API compatible changes)
* `hugr`: 0.15.3 -> 0.15.4 (✓ API compatible changes)
* `hugr-cli`: 0.15.3 -> 0.15.4 (✓ API compatible changes)
### ⚠ `hugr-llvm` breaking changes
```text
--- failure trait_missing: pub trait removed or renamed ---
Description:
A publicly-visible trait cannot be imported by its prior path. A `pub use` may have been removed, or the trait itself may have been renamed or removed entirely.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/trait_missing.ron
Failed in:
trait hugr_llvm::utils::array_op_builder::ArrayOpBuilder, previously in file /tmp/.tmpyTFqSG/hugr-llvm/src/utils/array_op_builder.rs:10
trait hugr_llvm::utils::ArrayOpBuilder, previously in file /tmp/.tmpyTFqSG/hugr-llvm/src/utils/array_op_builder.rs:10
```
<details><summary><i><b>Changelog</b></i></summary><p>
## `hugr-model`
<blockquote>
##
[0.19.0](hugr-model-v0.18.1...hugr-model-v0.19.0)
- 2025-04-02
### New Features
- Python bindings for `hugr-model`.
([#1959](#1959))
- Remove extension sets from `hugr-model`.
([#2031](#2031))
- Packages in `hugr-model` and envelope support.
([#2026](#2026))
- Represent order edges in `hugr-model` as metadata.
([#2027](#2027))
</blockquote>
## `hugr-core`
<blockquote>
##
[0.16.0](hugr-core-v0.15.3...hugr-core-v0.16.0)
- 2025-04-30
### New Features
- Export the portgraph hierarchy in HugrInternals
([#2057](#2057))
- Implement Debug for generic Wire<N>s
([#2068](#2068))
- Add ExtensionOp helpers
([#2072](#2072))
- ReplaceTypes: handlers for array constants + linearization
([#2023](#2023))
- move `ArrayOpBuilder` to hugr-core
([#2115](#2115))
### Testing
- Disable IO-dependent tests when running miri
([#2123](#2123))
</blockquote>
## `hugr-llvm`
<blockquote>
##
[0.16.0](hugr-llvm-v0.15.3...hugr-llvm-v0.16.0)
- 2025-04-30
### New Features
- move `ArrayOpBuilder` to hugr-core
([#2115](#2115))
</blockquote>
## `hugr-passes`
<blockquote>
##
[0.16.0](hugr-passes-v0.15.3...hugr-passes-v0.16.0)
- 2025-04-30
### New Features
- ReplaceTypes: handlers for array constants + linearization
([#2023](#2023))
</blockquote>
## `hugr`
<blockquote>
##
[0.16.0](hugr-v0.15.3...hugr-v0.16.0)
- 2025-04-30
### New Features
- Export the portgraph hierarchy in HugrInternals
([#2057](#2057))
- Implement Debug for generic Wire<N>s
([#2068](#2068))
- Add ExtensionOp helpers
([#2072](#2072))
- ReplaceTypes: handlers for array constants + linearization
([#2023](#2023))
- move `ArrayOpBuilder` to hugr-core
([#2115](#2115))
### Testing
- Disable IO-dependent tests when running miri
([#2123](#2123))
</blockquote>
## `hugr-cli`
<blockquote>
##
[0.15.3](hugr-cli-v0.15.2...hugr-cli-v0.15.3)
- 2025-04-02
### Documentation
- Add usage info to hugr-cli's rustdocs
([#2044](#2044))
</blockquote>
</p></details>
---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).
---------
Co-authored-by: Agustín Borgna <agustin.borgna@quantinuum.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Expands the module docstring of
hugr-cliso we can link people directly to https://docs.rs/hugr-cli/latest/hugr_cli/ instead of depending on github's README.