mirror of
https://github.com/FuelLabs/sway.git
synced 2025-08-18 17:41:07 +00:00
ceb384bc93
## Description Ran on test branch & working as intended. Only beginning of file `//!` is collected as `DocComment` with `DocStyle::Inner` which is only collected at the `Module` parsing stage. This ensures that any `//!` found after the module docs will be treated as normal comments for now. Ref #4112 for tracking further progress in allowing inner doc comments for `Item`. ## Checklist - [x] I have linked to any relevant issues. Closes #4097 - [x] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. |
||
|---|---|---|
| .. | ||
| src | ||
| tests | ||
| Cargo.toml | ||
| CONTRIBUTING.md | ||
| README.md | ||
swayfmt
A tool for formatting Sway code according to style guidelines.
Installation
To use swayfmt you'll need to install the forc-fmt plugin that will run the formatter. You can install the complete Fuel toolchain with fuelup, or for swayfmt only, see CONTRIBUTING.