Should we write attributes as `#[attribute_name]`?

Open
#407 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Review the Rust Reference’s current attribute-name examples and the existing convention for writing them in code blocks. The open question needs a project decision before implementation; done means the convention is agreed on and consistently applied in the relevant documentation.

Written by the indexing model from the issue text.

Description

A-attributes Authoring guide C-discussion

Due to how they've been written in the past, we write attribute names as just the names in code blocks. To make it more clear that they are attributes, should we make it a convention to put them in their brackets (#[]) when referring to them?

This might require a meeting to make a decision.

Dominant language
Rust
Stars
1.6k
Forks
607
Avg merge
1d 1h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-lang/reference

All issues in rust-lang/reference

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.