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

Adjust root package page content #13725

Closed
wants to merge 2 commits into from
Closed

Adjust root package page content #13725

wants to merge 2 commits into from

Conversation

heisen-li
Copy link
Contributor

@heisen-li heisen-li commented Apr 9, 2024 •
edited
Loading

What does this PR try to resolve?

part of #13580

explain the behavior of a root package

  1. added a description in the root package section of the workspace page of root package becoming the default member when no workspace member is specified.
  2. repositioned the definition of workspace root so that the definition itself appears where workspace root is first mentioned.

@rustbot
Copy link
Collaborator

rustbot commented Apr 9, 2024

r? @ehuss

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 9, 2024
@heisen-li heisen-li changed the title Improve Workspaces docs page Adjust root package page content Apr 10, 2024
@heisen-li heisen-li marked this pull request as ready for review April 10, 2024 03:26
@heisen-li heisen-li mentioned this pull request Apr 10, 2024
Open
@heisen-li
Copy link
Contributor Author

Sorry. Are there any other changes suggested?

weihanglo
weihanglo reviewed Apr 23, 2024
View reviewed changes
Copy link
Member

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

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

Thanks for the doc update.
Could you rework on Git commits in a reasonable manner? Some intermediate commits like “merge master” shouldn't be here.

src/doc/src/reference/workspaces.md Outdated Show resolved Hide resolved
src/doc/src/reference/workspaces.md Outdated Show resolved Hide resolved
src/doc/src/reference/workspaces.md Outdated Show resolved Hide resolved
src/doc/src/reference/workspaces.md Outdated Show resolved Hide resolved
@epage
Copy link
Contributor

epage commented Apr 23, 2024

@heisen-li I talked the challenge of writing this section with @weihanglo and had an idea on how to cover this topic. What are your thoughts on #13794?

@rustbot rustbot added A-cli Area: Command-line interface, option parsing, etc. A-cli-help Area: built-in command-line help A-completions Area: shell completions A-git Area: anything dealing with git A-rebuild-detection Area: rebuild detection and fingerprinting Command-add labels Apr 24, 2024
@heisen-li heisen-li closed this Apr 24, 2024
@heisen-li heisen-li deleted the workspace_doc branch April 24, 2024 02:54
@heisen-li heisen-li mentioned this pull request Apr 24, 2024
Closed
@heisen-li
Copy link
Contributor Author

@heisen-li I talked the challenge of writing this section with @weihanglo and had an idea on how to cover this topic. What are your thoughts on #13794?

I think it's fine, no other suggestions. I'll update the #13766 parser section a bit.

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

@epage epage epage left review comments

@weihanglo weihanglo weihanglo left review comments

Assignees

@ehuss ehuss

Labels
A-cli Area: Command-line interface, option parsing, etc. A-cli-help Area: built-in command-line help A-completions Area: shell completions A-documenting-cargo-itself Area: Cargo's documentation A-git Area: anything dealing with git A-rebuild-detection Area: rebuild detection and fingerprinting Command-add S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@heisen-li @rustbot @epage @weihanglo @ehuss