Skip to content
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

spirv-builder: try to get docs to build on docs.rs, and improve them slightly. #1079

Merged
merged 4 commits into from
Jul 14, 2023

Conversation

eddyb
Copy link
Contributor

@eddyb eddyb commented Jul 14, 2023

See each commit for more details, but the original motivation was the first commit (I was working on another change that requires spirv-builder additions and it would be great if I could link to docs.rs docs).

Quick diff for the second commit:

Before After
image image

The potentially controversial change is removing mentions of 0.4.0-alpha.* prereleases - they keep feeling out of place after so many more releases, and IMO if someone is updating from a 0.4.0-alpha.* prerelease, they should probably update to 0.4 proper first, and only then look at what was released since.

@eddyb eddyb requested a review from repi July 14, 2023 13:11
@eddyb eddyb force-pushed the spirv-builder-docs branch from 144b54b to 2400416 Compare July 14, 2023 13:34
@eddyb eddyb force-pushed the spirv-builder-docs branch from 2400416 to bc7c9d7 Compare July 14, 2023 14:27
Copy link
Contributor

@repi repi left a comment

Choose a reason for hiding this comment

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

looks good!

@eddyb eddyb marked this pull request as ready for review July 14, 2023 21:56
@eddyb eddyb enabled auto-merge (rebase) July 14, 2023 21:56
@eddyb eddyb merged commit e830e60 into EmbarkStudios:main Jul 14, 2023
@eddyb eddyb deleted the spirv-builder-docs branch July 14, 2023 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants