jshint / jshint.github.io

The homepage for JSHint
http://jshint.com
20 stars 19 forks source link

Small suggestion: "Use together with" -> "affects" #49

Closed kpage closed 7 years ago

kpage commented 7 years ago

Some developers on my team were confused with the wording of the documentation regarding exported. It says to use the exported comment together with the unused option. In our case, we enable the unused option in .jshintrc, but they thought that the unused had to be set in the same file if they wanted to use exported.

Small suggestion: could just state that the exported setting affects the unused option instead of stating that they must be used together, as "together" could be misinterpreted to imply that the settings must be set at the same time in the same configuration file/block.

jugglinmike commented 7 years ago

Sounds good to me. Thanks!