jshint / jshint/jshint.github.io

Inline global declaration doesn't work with single-line comments

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
22
Forks
18
PR merge metrics
No merged PRs in 30d

Description

See this issue: jshint/jshint#2135

TL;DR: It should be specified in the docs that while single-line comments are accepted for jshint's inline configuration, it doesn't work for global declaration.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reading the referenced jshint/jshint#2135 issue and locating the inline configuration documentation in this repository. Update the docs to explain that single-line comments are accepted for inline configuration but do not work for global declarations; done means that limitation is clearly documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.