rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update crate name and add README

Browse Source
This commit is contained in:
Rune Tynan
2021-01-25 16:23:43 -05:00
parent 3076e255fe
commit 67b78a0271
6 changed files with 24 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/rustdoc-json-types/Cargo.toml
View File

@@ -1,5 +1,5 @@
[package]
name = "json-types"
name = "rustdoc-json-types"
version = "0.1.0"
authors = ["The Rust Project Developers"]
edition = "2018"

12
src/rustdoc-json-types/README.md Normal file
View File

@@ -0,0 +1,12 @@
# Rustdoc JSON Types
This crate exposes the Rustdoc JSON API as a set of types with serde implementations.
These types are part of the public interface of the rustdoc JSON output, and making them
their own crate allows them to be versioned and distributed without having to depend on
any rustc/rustdoc internals. This way, consumers can rely on this crate for both documentation
of the output, and as a way to read the output easily, and its versioning is intended to
follow semver guarantees about the version of the format. JSON format X will always be
compatible with rustdoc-json-types version N.
Currently, this crate is only used by rustdoc itself. Upon the stabilization of
rustdoc-json, it may be start to be distributed separately for consumers of the API.