bevyengine / bevyengine/bevy-website

Emit line numbers in `write-rustdoc-hide-lines`

Open
#1,117 0 comments 0 reactions 0 assignees View on GitHub
C-Automation C-Feature
Dominant language
JavaScript
Stars
249
Forks
450
Avg merge
16h 20m
Merged PRs (30d)
6

Description

As a follow up to #1101, the `write-rustdoc-hide-lines` tool could be improved by emitting which line are not formatted properly. These lines can also be [emitted in CI](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message), which will make it more clear what is causing the job to fail.

Contributor guide

Open the contributing guide

Research direction

Locate the write-rustdoc-hide-lines entry point and trace how it detects lines that are not formatted properly. Check how the tool is invoked in CI, then verify that the reported line numbers appear both in its output and as GitHub Actions error annotations when the job fails.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
ci-cd, documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.