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

Add documentation update hint using cargo collect-metadata #11857

Merged
merged 1 commit into from
Nov 23, 2023

Conversation

matthri
Copy link
Contributor

@matthri matthri commented Nov 23, 2023

This adds a little reminder to update the documentation in the book using cargo collect-metadata after changing the lint configuration since this can easily be missed (been there done that 🙈).

Yeah a note would be good, would be good for us to see if we can make it automatic also

Originally posted by @Alexendoo in #11757 (comment)

Regarding the automation Im not sure whats the best option here. I thought about a kind of a "semi-automated" way, e.g. a cargo dev command which runs the "is the documentation updated" check (and maybe other useful checks) locally and reminds the user of updating the documentation so this gets caught before pushing.

changelog: none

This adds a hint to update the documentation in the book after changing the lint configuration
@rustbot
Copy link
Collaborator

rustbot commented Nov 23, 2023

r? @flip1995

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Nov 23, 2023
@flip1995
Copy link
Member

@bors r+

Thanks!

@bors
Copy link
Contributor

bors commented Nov 23, 2023

📌 Commit c18e6ab has been approved by flip1995

It is now in the queue for this repository.

@bors
Copy link
Contributor

bors commented Nov 23, 2023

⌛ Testing commit c18e6ab with merge 30c743f...

@bors
Copy link
Contributor

bors commented Nov 23, 2023

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: flip1995
Pushing 30c743f to master...

@bors bors merged commit 30c743f into rust-lang:master Nov 23, 2023
4 checks passed
@matthri matthri deleted the add-collect-metadata-note branch November 23, 2023 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants