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

Misc. cleanup tasks #53

Merged
merged 3 commits into from
May 7, 2024
Merged

Misc. cleanup tasks #53

merged 3 commits into from
May 7, 2024

Conversation

alilleybrinker
Copy link
Collaborator

This PR does a few things:

  • Replaces our pathbuf module with the pathbuf crate.
  • Moves some helper logic under a new util/ module.
  • Fixes cargo xtask doc --open.

These should be rebase-merged without a squash.

A while back I'd made a published crate called `pathbuf` that does the
same stuff we'd been doing in our own `pathbuf.rs` file, so let's just
use that instead of having our own code for it.

Signed-off-by: Andrew Lilley Brinker <[email protected]>
This is intended to help clarify the folder structure in Hipcheck. We
have some helper logic that wraps `std` functionality with nicer error
messages, or extends iterators with helpful new methods, and those can
now be found under the `util/` directory.

Signed-off-by: Andrew Lilley Brinker <[email protected]>
Turns out at some point, probably with the Clap upgrade, that we'd
broken the `--open` flag on the `cargo xtask doc` CLI. This commit fixes
it, so you can use `cargo xtask doc --open` to see the internal API docs
of the `hc` crate.

Signed-off-by: Andrew Lilley Brinker <[email protected]>
@alilleybrinker alilleybrinker added type: bug Something isn't working type: enhancement New feature or request labels May 7, 2024
@alilleybrinker alilleybrinker added this to the 3.2.0 milestone May 7, 2024
@alilleybrinker alilleybrinker self-assigned this May 7, 2024
@alilleybrinker alilleybrinker merged commit c5092ab into main May 7, 2024
9 checks passed
@alilleybrinker alilleybrinker deleted the alilleybrinker/cleanup branch May 7, 2024 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug Something isn't working type: enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant