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

Move format-version constant to rustdoc-json-types #88620

Closed
jyn514 opened this issue Sep 3, 2021 · 9 comments
Closed

Move format-version constant to rustdoc-json-types #88620

jyn514 opened this issue Sep 3, 2021 · 9 comments
Assignees
@yuvaldolev
Labels
A-rustdoc-json Area: Rustdoc JSON backend E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. requires-nightly This issue requires a nightly compiler in some way. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jyn514
Copy link
Member

jyn514 commented Sep 3, 2021 •
edited by rustbot
Loading

Right now, the format-version is in rustdoc and not in rustdoc-json-types, which has two downsides:

  1. It's harder to make sure they're kept in sync
  2. Downstream users can't know the version ahead of time, they're forced to hard-code it in their own code as well.

We should move it to rustdoc-json-types instead.

Originally posted by @jyn514 in #88604 (comment)
@jyn514 jyn514 added A-rustdoc-json Area: Rustdoc JSON backend requires-nightly This issue requires a nightly compiler in some way. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Sep 3, 2021
@Rustin170506
Copy link
Member

@rustbot claim

@jyn514
Copy link
Member Author

jyn514 commented Oct 11, 2021

Hi @hi-rustin, are you still planning to work on this?

@Rustin170506
Copy link
Member

Hi @hi-rustin, are you still planning to work on this?

Sorry, I've been a little busy lately. I will cancel the assignment. Let someone who wants to fix it.

@Rustin170506 Rustin170506 removed their assignment Oct 11, 2021
@yuvaldolev
Copy link
Contributor

yuvaldolev commented Oct 11, 2021 •
edited
Loading

Hi @jyn514 !
Can I claim this issue if no one else is working on it?

@jyn514
Copy link
Member Author

jyn514 commented Oct 11, 2021

@yuvaldolev go for it :)

@yuvaldolev
Copy link
Contributor

@rustbot claim

@yuvaldolev
Copy link
Contributor

Hi, @jyn514
What, in your opinion, is the best place for the format-version constant within rustdoc-json-types?
I'm currently thinking of placing it in the lib.rs file, at the crate root - does that sound good?

@jyn514
Copy link
Member Author

jyn514 commented Oct 13, 2021

@yuvaldolev yup, that sounds fine :)

@yuvaldolev yuvaldolev mentioned this issue Oct 15, 2021
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Oct 15, 2021
@matthiaskrgr
Rollup merge of rust-lang#89906 - yuvaldolev:move-format-version-to-r…
d401815 
…ustdoc-json-types, r=CraftSpider

Moved format-version constant to rustdoc-json-types

Addresses rust-lang#88620

Moved format-version constant from rustdoc to rustdoc-json-types.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Oct 15, 2021
@matthiaskrgr
Rollup merge of rust-lang#89906 - yuvaldolev:move-format-version-to-r…
0c83d9e 
…ustdoc-json-types, r=CraftSpider

Moved format-version constant to rustdoc-json-types

Addresses rust-lang#88620

Moved format-version constant from rustdoc to rustdoc-json-types.
jackh726 added a commit to jackh726/rust that referenced this issue Oct 16, 2021
@jackh726
Rollup merge of rust-lang#89906 - yuvaldolev:move-format-version-to-r…
c81cbb1 
…ustdoc-json-types, r=CraftSpider

Moved format-version constant to rustdoc-json-types

Addresses rust-lang#88620

Moved format-version constant from rustdoc to rustdoc-json-types.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Oct 16, 2021
@matthiaskrgr
Rollup merge of rust-lang#89906 - yuvaldolev:move-format-version-to-r…
e98669a 
…ustdoc-json-types, r=CraftSpider

Moved format-version constant to rustdoc-json-types

Addresses rust-lang#88620

Moved format-version constant from rustdoc to rustdoc-json-types.
@camelid
Copy link
Member

camelid commented Oct 18, 2021

Fixed in #89906.

@camelid camelid closed this as completed Oct 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yuvaldolev yuvaldolev

Labels
A-rustdoc-json Area: Rustdoc JSON backend E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. requires-nightly This issue requires a nightly compiler in some way. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jyn514 @yuvaldolev @Rustin170506 @camelid