stdlib-js / stdlib-js/stdlib

Linting docstrings bug

Open
#1,042 1 comment 0 reactions 0 assignees View on GitHub
Tools
Dominant language
JavaScript
Stars
6k
Forks
1.3k
Avg merge
1d 3h
Merged PRs (30d)
611

Description

This is a follow up issue from the discussion _Originally posted by @kgryte in https://github.com/stdlib-js/stdlib/pull/1041#discussion_r1244843249_

The CI linter passed even though the returned array in the docstring was `Float64Array`, but the data type of the input array is `generic`.

Contributor guide

Open the contributing guide

Research direction

Start with the discussion referenced in pull request #1041, which describes the linter accepting a docstring return type of Float64Array for a generic input array. Reproduce that case in CI or the linter’s existing checks and determine what validation is missing. Done means the mismatch is detected and covered by an appropriate test.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.