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.

Sign up for GitHub

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

Jump to bottom

rustdoc: Rename typedef to type alias #115078

Merged
merged 6 commits into from Aug 24, 2023
Merged

rustdoc: Rename typedef to type alias #115078

merged 6 commits into from Aug 24, 2023

Conversation

camelid
Copy link
Member

@camelid camelid commented Aug 21, 2023

This matches the name used by the Rust Reference, which is also what
people usually call these items.

r? @GuillaumeGomez

@rustbot rustbot added A-rustdoc-json Area: Rustdoc JSON backend S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 21, 2023
@rustbot
Copy link
Collaborator

rustbot commented Aug 21, 2023

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha

rustdoc-json-types is a public (although nightly-only) API. If possible, consider changing src/librustdoc/json/conversions.rs; otherwise, make sure you bump the FORMAT_VERSION constant.

cc @CraftSpider, @aDotInTheVoid, @Enselic, @obi1kenobi

@GuillaumeGomez
Copy link
Member

Thanks!

r=me once CI pass

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rustbot
Copy link
Collaborator

rustbot commented Aug 21, 2023

Some changes occurred in GUI tests.

cc @GuillaumeGomez

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@Enselic Enselic mentioned this pull request Aug 22, 2023
Merged
aDotInTheVoid
aDotInTheVoid requested changes Aug 23, 2023
View reviewed changes
Copy link
Member

@aDotInTheVoid aDotInTheVoid left a comment •
edited

Choose a reason for hiding this comment

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

Looks good WRT Rustdoc-JSON couple of naming nits to keeps the tools consistant with the lib. Running a find and replace of inner.typedef to inner.type_alias should fix most of the rustdoc-json tests.

src/tools/jsondoclint/src/item_kind.rs Outdated Show resolved Hide resolved
src/tools/jsondoclint/src/validator.rs Outdated Show resolved Hide resolved
@aDotInTheVoid aDotInTheVoid mentioned this pull request Aug 23, 2023
Open
2 tasks
@aDotInTheVoid
Copy link
Member

@bors r=aDotInTheVoid,GuillaumeGomez

@bors
Copy link
Contributor

bors commented Aug 23, 2023

📌 Commit 912d11d has been approved by aDotInTheVoid,GuillaumeGomez

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 23, 2023
@bors
Copy link
Contributor

bors commented Aug 24, 2023

⌛ Testing commit 912d11d with merge 9bd60a6...

@bors
Copy link
Contributor

bors commented Aug 24, 2023

☀️ Test successful - checks-actions
Approved by: aDotInTheVoid,GuillaumeGomez
Pushing 9bd60a6 to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Aug 24, 2023
@bors bors merged commit 9bd60a6 into rust-lang:master Aug 24, 2023
12 checks passed
@rustbot rustbot added this to the 1.74.0 milestone Aug 24, 2023
aDotInTheVoid added a commit to aDotInTheVoid/rustdoc-types that referenced this pull request Aug 24, 2023
@aDotInTheVoid
v0.23.0
577a774 
rust-lang/rust#115078
@bors bors mentioned this pull request Aug 24, 2023
Merged
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (9bd60a6): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)		 - - 0
Regressions ❌
(secondary)		 1.0% [1.0%, 1.0%] 1
Improvements ✅
(primary)		 - - 0
Improvements ✅
(secondary)		 -1.8% [-2.4%, -1.4%] 3
All ❌✅ (primary) - - 0

Cycles

This benchmark run did not return any relevant results for this metric.

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 632.475s -> 631.241s (-0.20%)
Artifact size: 346.61 MiB -> 346.61 MiB (-0.00%)

@Enselic Enselic mentioned this pull request Aug 24, 2023
Merged
@camelid camelid deleted the tydef-to-alias branch August 24, 2023 21:05
@tottoto tottoto mentioned this pull request Aug 28, 2023
Merged
@jdahlstrom
Copy link

jdahlstrom commented Nov 26, 2023 •
edited

Just wanted to say thanks :D The use of a wrong term bothered me a while ago but not enough to create an issue right away. Now I thought I'd finally create one, but when I double-checked the docs it was already fixed 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aDotInTheVoid aDotInTheVoid aDotInTheVoid requested changes

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees

@GuillaumeGomez GuillaumeGomez

Labels
A-rustdoc-json Area: Rustdoc JSON backend merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.74.0
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@camelid @rustbot @GuillaumeGomez @rust-log-analyzer @aDotInTheVoid @bors @rust-timer @jdahlstrom