Skip to content

Commit 7fc07fa

Browse files
committed
v0.31.0
1 parent a4a9cab commit 7fc07fa

File tree

4 files changed

+18
-7
lines changed

4 files changed

+18
-7
lines changed

CHANGELOG.md

+11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
<a name="v0.31.0"></a>
2+
# [v0.31.0](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/v0.31.0) - 2024-10-13
3+
4+
**Breaking Change**: The `Id` type now wraps a `u32` instead of a `String`. The should hopefully increase performance ([rust#130078](https://github.com/rust-lang/rust/pull/130078)).
5+
6+
**Documentation Improvement**: Remove false claim from `ProcMacro::helpers` docs ([rust#130939](https://github.com/rust-lang/rust/pull/130939)).
7+
8+
- Format Version: 35
9+
- Upstream Commit: [`05c0591321f9956c1f0df4785d3737f40cffb598`](https://github.com/rust-lang/rust/commit/05c0591321f9956c1f0df4785d3737f40cffb598)
10+
- Diff: [v0.30.0...v0.31.0](https://github.com/aDotInTheVoid/rustdoc-types/compare/v0.30.0...v0.31.0)
11+
112
<a name="v0.30.0"></a>
213
# [v0.30.0](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/v0.30.0) - 2024-09-13
314

COMMIT.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
f2696ab4d3095bb6ad6197e55855ebdf00f50b80
1+
05c0591321f9956c1f0df4785d3737f40cffb598

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rustdoc-types"
3-
version = "0.30.0"
3+
version = "0.31.0"
44
edition = "2018"
55
license = "MIT OR Apache-2.0"
66
description = "Types for rustdoc's json output"

src/lib.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ use serde::{Deserialize, Serialize};
1313
/// This integer is incremented with every breaking change to the API,
1414
/// and is returned along with the JSON blob as [`Crate::format_version`].
1515
/// Consuming code should assert that this value matches the format version(s) that it supports.
16-
pub const FORMAT_VERSION: u32 = 34;
16+
pub const FORMAT_VERSION: u32 = 35;
1717

1818
/// The root of the emitted JSON blob.
1919
///
@@ -296,9 +296,9 @@ pub enum AssocItemConstraintKind {
296296
/// Rustdoc makes no guarantees about the inner value of Id's. Applications
297297
/// should treat them as opaque keys to lookup items, and avoid attempting
298298
/// to parse them, or otherwise depend on any implementation details.
299-
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
299+
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
300300
// FIXME(aDotInTheVoid): Consider making this non-public in rustdoc-types.
301-
pub struct Id(pub String);
301+
pub struct Id(pub u32);
302302

303303
/// The fundamental kind of an item. Unlike [`ItemEnum`], this does not carry any aditional info.
304304
///
@@ -677,7 +677,7 @@ pub struct FunctionHeader {
677677
/// on unwinding for more info.
678678
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
679679
pub enum Abi {
680-
// We only have a concrete listing here for stable ABI's because their are so many
680+
// We only have a concrete listing here for stable ABI's because there are so many
681681
// See rustc_ast_passes::feature_gate::PostExpansionVisitor::check_abi for the list
682682
/// The default ABI, but that can also be written explicitly with `extern "Rust"`.
683683
Rust,
@@ -1168,7 +1168,7 @@ pub struct ProcMacro {
11681168
pub kind: MacroKind,
11691169
/// Helper attributes defined by a macro to be used inside it.
11701170
///
1171-
/// Defined only for attribute & derive macros.
1171+
/// Defined only for derive macros.
11721172
///
11731173
/// E.g. the [`Default`] derive macro defines a `#[default]` helper attribute so that one can
11741174
/// do:

0 commit comments

Comments
 (0)