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

rustdoc-json-types: Improve ItemSummary::path docs #103664

Merged
merged 1 commit into from
Oct 29, 2022

Conversation

aDotInTheVoid
Copy link
Member

Somewhat inspired by the doc changes from #103085 (cc @Urgau)

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 Oct 28, 2022
@rustbot
Copy link
Collaborator

rustbot commented Oct 28, 2022

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

Copy link
Member

@Urgau Urgau left a comment

Choose a reason for hiding this comment

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

LGTM, maybe just add that it is currently implementation defined (so as not to give too many guarantees) ?

@GuillaumeGomez
Copy link
Member

I agree with @Urgau's suggestion: let's not give too many guarantees so please update your comment to reflect it. But otherwise looks all good, thanks!

@aDotInTheVoid
Copy link
Member Author

Good suggestion, updated

@GuillaumeGomez
Copy link
Member

Thanks!

@bors r=Urgau,GuillaumeGomez rollup

@bors
Copy link
Contributor

bors commented Oct 28, 2022

📌 Commit 064ad83 has been approved by Urgau,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 Oct 28, 2022
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Oct 29, 2022
…au,GuillaumeGomez

rustdoc-json-types: Improve ItemSummary::path docs

Somewhat inspired by the doc changes from rust-lang#103085 (cc `@Urgau)`

r? `@GuillaumeGomez`
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 29, 2022
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#102961 (Make `CStr::from_ptr` `const`.)
 - rust-lang#103342 (Add test for issue 98634)
 - rust-lang#103383 (Note scope of TAIT more accurately)
 - rust-lang#103656 (Specialize ToString for Symbol)
 - rust-lang#103663 (rustdoc: remove redundant CSS/DOM `div.search-container`)
 - rust-lang#103664 (rustdoc-json-types: Improve ItemSummary::path docs)
 - rust-lang#103704 (Add a test for TAIT used with impl/dyn Trait inside RPIT)

Failed merges:

 - rust-lang#103618 (Rename some `OwnerId` fields.)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 2ea6611 into rust-lang:master Oct 29, 2022
@rustbot rustbot added this to the 1.66.0 milestone Oct 29, 2022
aDotInTheVoid added a commit to rust-lang/rustdoc-types that referenced this pull request Nov 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-json Area: Rustdoc JSON backend 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
Development

Successfully merging this pull request may close these issues.

5 participants