Skip to content

Update all package.json descriptions #4315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
2 tasks done
andyleejordan opened this issue Dec 7, 2022 · 0 comments · Fixed by #4320
Closed
2 tasks done

Update all package.json descriptions #4315

andyleejordan opened this issue Dec 7, 2022 · 0 comments · Fixed by #4320
Assignees
Labels
Area-Configuration Issue-Enhancement A feature request (enhancement).

Comments

@andyleejordan
Copy link
Member

Prerequisites

  • I have written a descriptive issue title.
  • I have searched all issues to ensure it has not already been reported.

Summary

Quite a few of our setting and command descriptions in package.json, for instance:

        "powershell.scriptAnalysis.enable": {
          "type": "boolean",
          "default": true,
          "description": "Enables real-time script analysis from PowerShell Script Analyzer. Uses the newest installed version of the PSScriptAnalyzer module or the version bundled with this extension, if it is newer."
        },

is totally wrong.

I was about to fix just this, but then was looking through and most if not all of these should be reviewed and updated. Furthermore, it would be a great improvement to switch to markdownDescription and have proper links to mentioned settings, etc.

Proposed Design

No response

@andyleejordan andyleejordan added Issue-Enhancement A feature request (enhancement). Area-Configuration labels Dec 7, 2022
@andyleejordan andyleejordan self-assigned this Dec 7, 2022
@ghost ghost added the Needs: Triage Maintainer attention needed! label Dec 7, 2022
@andyleejordan andyleejordan removed the Needs: Triage Maintainer attention needed! label Dec 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Configuration Issue-Enhancement A feature request (enhancement).
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant