bevyengine / bevyengine/bevy

Add CI task to automatically format docstring comment line lengths

Open
#1,594 5 comments 0 reactions 0 assignees View on GitHub
A-Build-System C-Code-Quality C-Docs D-Trivial S-Blocked
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 22h
Merged PRs (30d)
161

Description

## What problem does this solve or what need does it fill?

Keeping lines to a fixed width makes them easier to read, and avoids noisy commits as this is periodically fixed.

## What solution would you like?

Add a task to the CI that automatically formats docstring line length to 100 characters, like the code.

## What alternative(s) have you considered?

It may also be possible to do this on the user side with `cargo fmt` configuration options?

## Additional context

This was mentioned to me by @Ratysz when working on #1578, and will likely come up repeatedly as new contributors add to docs.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.