Skip to content
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

Remove outdated about_scriptanalyzer help file #951

Merged
merged 2 commits into from Apr 9, 2018

Conversation

@bergmeister
Copy link
Collaborator

bergmeister commented Mar 28, 2018

PR Summary

about_scriptanalyzer is terribly outdated and does not provide more help than cmdlet help itself. I think it is better to follow the DRY principle and remove it to avoid repetition that just leads to outdated documentation.
I also updated the required platyPS version in a version check, which was still using the old value
A 2nd PR could potentially simply the directory structure from root\docs\markdown to root\docs since the docs folder contains now only the markdown folder.

PR Checklist

Note: Tick the boxes below that apply to this pull request by putting an x between the square brackets. Please mark anything not applicable to this PR NA.

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • User facing documentation needed
  • Change is not breaking
  • NA Make sure you've added a new test if existing tests do not effectively test the code changed
  • This PR is ready to merge and is not work in progress
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready
…eing markdown based.
@bergmeister bergmeister changed the title Remove old cmdlet help file that is not needed any more due to help being markdown based. WIP Remove old cmdlet help file that is not needed any more due to help being markdown based. Mar 28, 2018
@bergmeister
Copy link
Collaborator Author

bergmeister commented Mar 28, 2018

This was too quick. I need to go back and look at it in more detail.

@bergmeister bergmeister changed the title WIP Remove old cmdlet help file that is not needed any more due to help being markdown based. WIP Remove outdated about_scriptanalyzer help file Apr 1, 2018
…arkdown. Also correct version of platyps
@bergmeister bergmeister reopened this Apr 1, 2018
@bergmeister bergmeister self-assigned this Apr 1, 2018
@bergmeister bergmeister changed the title WIP Remove outdated about_scriptanalyzer help file Remove outdated about_scriptanalyzer help file Apr 1, 2018
@bergmeister bergmeister removed the in progress label Apr 1, 2018
@bergmeister bergmeister modified the milestone: 1.17 Apr 1, 2018
@JamesWTruher
Copy link
Member

JamesWTruher commented Apr 9, 2018

LGTM

@JamesWTruher JamesWTruher merged commit 2fc3911 into PowerShell:development Apr 9, 2018
2 checks passed
2 checks passed
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
license/cla All CLA requirements met.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.