-
Notifications
You must be signed in to change notification settings - Fork 13.5k
Split rustdoc JSON types into separately versioned crate #81287
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c689b97
Split JSON into separately versioned crate
CraftSpider 428bc14
Update cargo.lock
CraftSpider 28f6cab
Allow rustc::default_hash_types in the offending statement
CraftSpider 3c28069
Move into src/etc
CraftSpider cca4eea
Simplify conversion
CraftSpider 3076e25
`src/etc/json-types` -> `src/rustdoc-json-types`
CraftSpider 67b78a0
Update crate name and add README
CraftSpider 3aa8456
Fix README typo
CraftSpider File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update crate name and add README
- Loading branch information
commit 67b78a027111090feccc8434ce9634c9f65ec34d
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.