<commit_before># jsdoc-leading-description-sentence

> [ESLint rule][eslint-rules] to enforce that JSDoc descriptions start with an uppercase letter and end with a period.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence' );
```

#### rule

[ESLint rule][eslint-rules] to enforce that JSDoc descriptions start with an uppercase letter and end with a period.

**Bad**:

<!-- eslint-disable stdlib/jsdoc-leading-description-sentence -->

```javascript
/**
* returns a pseudo-random number on [0,1]
*
* @returns {number} uniform random number
*
* @example
* var y = rand();
* // e.g., returns 0.5363925252089496
*/
function rand() {
    return Math.random();
}
```

**Good**:

```javascript
/**
* Returns a pseudo-random number on [0,1].
*
* @returns {number} uniform random number
*
* @example<commit_msg>Resolve lint errors<commit_after># jsdoc-leading-description-sentence

> [ESLint rule][eslint-rules] to enforce that JSDoc descriptions start with an uppercase letter and end with a period.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence' );
```

#### rule

[ESLint rule][eslint-rules] to enforce that JSDoc descriptions start with an uppercase letter and end with a period.

**Bad**:

<!-- eslint-disable stdlib/jsdoc-leading-description-sentence -->

```javascript
/**
* returns a pseudo-random number on `[0,1]`
*
* @returns {number} uniform random number
*
* @example
* var y = rand();
* // e.g., returns 0.5363925252089496
*/
function rand() {
    return Math.random();
}
```

**Good**:

```javascript
/**
* Returns a pseudo-random number on `[0,1]`.
*
* @returns {number} uniform random number
*
* @example
{'fraction_non_alphanumeric': 0.16455696202531644, 'fraction_numerical': 0.022151898734177215, 'mean_word_length': 4.284122562674095, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 15, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5329949', 'n_tokens_mistral': 646, 'n_tokens_neox': 602, 'n_words': 179}