> For AI agents: the complete documentation index is available at https://rslint.rs/llms.txt, the full documentation bundle is available at https://rslint.rs/llms-full.txt.

# symbol-description

[Added in v0.5.0](https://github.com/web-infra-dev/rslint/releases/tag/v0.5.0)
## Configuration


```ts title=rslint.config.ts
import { defineConfig, js } from '@rslint/core';

export default defineConfig([
  js.configs.recommended,
  {
    rules: {
      'symbol-description': 'error',
    },
  },
]);
```

## Rule Details

Requires a description when creating a `Symbol`. A description makes logged and debugged symbols easier to identify.

Examples of **incorrect** code for this rule:

```javascript
var foo = Symbol();
```

Examples of **correct** code for this rule:

```javascript
var foo = Symbol("some description");

var someString = "some description";
var bar = Symbol(someString);
```

## Original Documentation

- [ESLint: symbol-description](https://eslint.org/docs/latest/rules/symbol-description)
- [Source code](https://github.com/eslint/eslint/blob/v10.8.1/lib/rules/symbol-description.js)
