Skip to content

Document custom attributes #7549

Open
Open
@Savio-Sou

Description

Context

As of #6235, developers can define arbitrary attributes with the syntax #['attribute(optional_parameters)].

This is useful for teams building Noir tooling that aims to provide additional features for their users who annotate their code with custom attributes specific to such tooling (e.g. annotate coSNARK-specific items).

Goal

Document the feature to ease such teams leveraging it.

Question

Do these custom attributes show up in Nargo's compiled artifacts?

Additional thoughts on naming

The implementing PR proposed naming the feature as "tag attributes" out of concern of confusions, as the core team used to refer arbitrary attributes without ' as "custom attributes", which is now deprecated with the PR.

This Issue proposes to continual naming it as "custom attributes" instead. The better intuitiveness it provides could justify the limited confusions it might cause (as the name was used only internally).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

  • Status

    📋 Backlog

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions