Rename `source` to `span` and `span` to `source` by camelid · Pull Request #82994 · rust-lang/rust

camelid · 2021-03-10T23:23:47Z

Rename clean::Item.source to span
Rename clean::Span::span() to clean::Span::inner()
Rename rustdoc_json_types::Item.source to span
rustdoc-json: Rename Import.span to Import.source

See also the discussion on Zulip (this is a bit more than discussed in
that conversation, but all the changes are related).

r? @jyn514

rust-highfive · 2021-03-10T23:23:49Z

Some changes occurred in intra-doc-links.

cc @jyn514

camelid · 2021-03-10T23:25:30Z

This will likely conflict with #82993 so probably one of these should be merged before the other.

camelid · 2021-03-10T23:27:51Z

Rebased to fix conflicts.

jyn514 · 2021-03-11T05:34:08Z

rustdoc-json: Rename Import.span to Import.source

Why this change?

camelid · 2021-03-11T18:50:45Z

rustdoc-json: Rename Import.span to Import.source

Why this change?

Quoting from the commit message:

It is called source in rustc and the rest of rustdoc

It is not a span, rather it is the source of the import

jyn514

LGTM with the nits fixed :)

src/librustdoc/clean/types.rs

src/librustdoc/json/conversions.rs

camelid · 2021-03-20T21:53:01Z

Addressed most of the comments, but I'm waiting on a response on #82994 (comment).

Its type is called `clean::Span`, and also the name in the rest of rustdoc and rustc for this kind of field is `span`.

Otherwise you get a lot of instances of `item.span.span()`, which is just plain confusing. `item.span.inner()` conveys the correct meaning of "get the type that `clean::Span` wraps".

* It is called `source` in rustc and the rest of rustdoc * It is not a span, rather it is the source of the import

The rustdoc-json-types renames are breaking changes.

...and add docs to the types instead of the fields that hold the types.

These tests were added to master after I made my changes.

src/librustdoc/clean/types.rs

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

jyn514 · 2021-03-23T18:33:48Z

Looks great, thanks!

@bors r+

bors · 2021-03-23T18:33:49Z

📌 Commit d5f2bb2 has been approved by jyn514

bors · 2021-03-23T19:06:18Z

⌛ Testing commit d5f2bb2 with merge 673d0db...

…n514 Rename `source` to `span` and `span` to `source` - Rename `clean::Item.source` to `span` - Rename `clean::Span::span()` to `clean::Span::inner()` - Rename `rustdoc_json_types::Item.source` to `span` - rustdoc-json: Rename `Import.span` to `Import.source` *See also the [discussion on Zulip][z] (this is a bit more than discussed in that conversation, but all the changes are related).* r? ``@jyn514`` [z]: https://rust-lang.zulipchat.com/#narrow/stream/182449-t-compiler.2Fhelp/topic/get.20span.20of.20file.20from.20name/near/229603729

bors · 2021-03-23T21:49:46Z

☀️ Test successful - checks-actions
Approved by: jyn514
Pushing 673d0db to master...

camelid added C-cleanup Category: PRs that clean code up or issues documenting cleanup. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Mar 10, 2021

rust-highfive assigned jyn514 Mar 10, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 10, 2021

camelid mentioned this pull request Mar 10, 2021

rustdoc: Use diagnostics for error when including sources #82993

Merged

camelid force-pushed the rename-source-to-span branch from 5eb5be2 to 0ee92b9 Compare March 10, 2021 23:27

This comment has been minimized.

Sign in to view

camelid force-pushed the rename-source-to-span branch from 0ee92b9 to 3261656 Compare March 10, 2021 23:54

This comment has been minimized.

Sign in to view

camelid force-pushed the rename-source-to-span branch from 3261656 to a32a68a Compare March 11, 2021 00:46

jyn514 reviewed Mar 20, 2021

View reviewed changes

camelid added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Mar 20, 2021

camelid removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Mar 20, 2021

This comment has been minimized.

Sign in to view

camelid added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Mar 22, 2021

camelid added 7 commits March 21, 2021 19:47

Rename clean::Item.source to span

8b9b106

Its type is called `clean::Span`, and also the name in the rest of rustdoc and rustc for this kind of field is `span`.

Rename clean::Span::span() to clean::Span::inner()

7dd475e

Otherwise you get a lot of instances of `item.span.span()`, which is just plain confusing. `item.span.inner()` conveys the correct meaning of "get the type that `clean::Span` wraps".

Rename rustdoc_json_types::Item.source to span

e190983

rustdoc-json: Rename Import.span to Import.source

b0659f9

* It is called `source` in rustc and the rest of rustdoc * It is not a span, rather it is the source of the import

Bump rustdoc-json format version

9b9bb71

The rustdoc-json-types renames are breaking changes.

Remove redundant docs

bec7ab2

...and add docs to the types instead of the fields that hold the types.

Update tests

99ff276

These tests were added to master after I made my changes.

camelid force-pushed the rename-source-to-span branch from 6253c88 to 99ff276 Compare March 22, 2021 02:50

camelid removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Mar 22, 2021

jyn514 reviewed Mar 22, 2021

View reviewed changes

src/librustdoc/clean/types.rs Outdated Show resolved Hide resolved

jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 22, 2021

Tweak docs

d5f2bb2

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

camelid added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 23, 2021

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 Mar 23, 2021

Dylan-DPC-zz mentioned this pull request Mar 23, 2021

Rollup of 9 pull requests #83422

Closed

bors added the merged-by-bors This PR was explicitly merged by bors. label Mar 23, 2021

bors merged commit 673d0db into rust-lang:master Mar 23, 2021

rustbot added this to the 1.53.0 milestone Mar 23, 2021

camelid deleted the rename-source-to-span branch March 24, 2021 00:06

Uh oh!

Conversation

camelid commented Mar 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rust-highfive commented Mar 10, 2021

Uh oh!

camelid commented Mar 10, 2021

Uh oh!

camelid commented Mar 10, 2021

Uh oh!

This comment has been minimized.

This comment has been minimized.

jyn514 commented Mar 11, 2021

Uh oh!

camelid commented Mar 11, 2021

Uh oh!

jyn514 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

camelid commented Mar 20, 2021

Uh oh!

This comment has been minimized.

Uh oh!

jyn514 commented Mar 23, 2021

Uh oh!

bors commented Mar 23, 2021

Uh oh!

bors commented Mar 23, 2021

Uh oh!

bors commented Mar 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

camelid commented Mar 10, 2021 •

edited

Loading