Skip to content

Prepare clippy_utils README and Cargo.toml for publishing #13693

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 17, 2024
Merged

Prepare clippy_utils README and Cargo.toml for publishing #13693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions clippy_utils/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
name = "clippy_utils"
version = "0.1.84"
edition = "2021"
description = "Helpful tools for writing lints, provided as they are used in Clippy"
repository = "https://github.com/rust-lang/rust-clippy"
readme = "README.md"
license = "MIT OR Apache-2.0"
keywords = ["clippy", "lint", "utils"]
categories = ["development-tools"]

[dependencies]
arrayvec = { version = "0.7", default-features = false }
Expand Down
40 changes: 40 additions & 0 deletions clippy_utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# `clippy-utils`

Helpful tools for writing lints, provided as they are used in Clippy.

## Usage

This crate is only guaranteed to build with this `nightly` toolchain:

<!-- begin autogenerated nightly -->
```
nightly-2024-11-14
```
<!-- end autogenerated nightly -->
Comment on lines +9 to +13
Copy link
Contributor

@BD103 BD103 Nov 17, 2024

Choose a reason for hiding this comment

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

(Nit) This could be moved to be under the "Usage" section, where it is referred to. (As long as the generation script can handle that!)

Copy link
Member Author

@flip1995 flip1995 Nov 17, 2024

Choose a reason for hiding this comment

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

I could, I put it here to put it as early as possible in the README.md, so that scrolling isn't necessary to get to the version. I can change this.

Copy link
Member Author

@flip1995 flip1995 Nov 17, 2024

Choose a reason for hiding this comment

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

Moved it.


To use `clippy-utils` in your lint, add the following to your `Cargo.toml`:

```
clippy_utils = "0.1.XY"
```

`XY` is the version of the nightly toolchain above and can be determined with `rustc +nightly-YYYY-MM-DD -V`.

## :warning: Stability :warning:

No stability guarantees are made for this crate! Use at your own risk.

Function signatures can change or be removed without replacement without any prior notice.

## LICENSE

<!-- REUSE-IgnoreStart -->

Copyright 2014-2024 The Rust Project Developers

Licensed under the Apache License, Version 2.0
<[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)> or the MIT license
<[https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)>, at your option. Files in the project may
not be copied, modified, or distributed except according to those terms.

<!-- REUSE-IgnoreEnd -->