Skip to content

Commit

Permalink
v0.31.0
Browse files Browse the repository at this point in the history
  • Loading branch information
aDotInTheVoid committed Oct 13, 2024
1 parent a4a9cab commit 7fc07fa
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
<a name="v0.31.0"></a>
# [v0.31.0](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/v0.31.0) - 2024-10-13

**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)).

**Documentation Improvement**: Remove false claim from `ProcMacro::helpers` docs ([rust#130939](https://github.com/rust-lang/rust/pull/130939)).

- Format Version: 35
- Upstream Commit: [`05c0591321f9956c1f0df4785d3737f40cffb598`](https://github.com/rust-lang/rust/commit/05c0591321f9956c1f0df4785d3737f40cffb598)
- Diff: [v0.30.0...v0.31.0](https://github.com/aDotInTheVoid/rustdoc-types/compare/v0.30.0...v0.31.0)

<a name="v0.30.0"></a>
# [v0.30.0](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/v0.30.0) - 2024-09-13

Expand Down
2 changes: 1 addition & 1 deletion COMMIT.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
f2696ab4d3095bb6ad6197e55855ebdf00f50b80
05c0591321f9956c1f0df4785d3737f40cffb598
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "rustdoc-types"
version = "0.30.0"
version = "0.31.0"
edition = "2018"
license = "MIT OR Apache-2.0"
description = "Types for rustdoc's json output"
Expand Down
10 changes: 5 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use serde::{Deserialize, Serialize};
/// This integer is incremented with every breaking change to the API,
/// and is returned along with the JSON blob as [`Crate::format_version`].
/// Consuming code should assert that this value matches the format version(s) that it supports.
pub const FORMAT_VERSION: u32 = 34;
pub const FORMAT_VERSION: u32 = 35;

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

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

0 comments on commit 7fc07fa

Please sign in to comment.