Title: PSProvideCommentHelp should not generate informational messages for functions internal to a module · Issue #199 · PowerShell/PSScriptAnalyzer · GitHub
Open Graph Title: PSProvideCommentHelp should not generate informational messages for functions internal to a module · Issue #199 · PowerShell/PSScriptAnalyzer
X Title: PSProvideCommentHelp should not generate informational messages for functions internal to a module · Issue #199 · PowerShell/PSScriptAnalyzer
Description: Today when I run Invoke-ScriptAnalyzer against my DoPx module, 5 informational messages are generated for the PSProvideCommentHelp rule indicating that I should provide comment-based help for the 5 functions that were discovered by this ...
Open Graph Description: Today when I run Invoke-ScriptAnalyzer against my DoPx module, 5 informational messages are generated for the PSProvideCommentHelp rule indicating that I should provide comment-based help for the 5...
X Description: Today when I run Invoke-ScriptAnalyzer against my DoPx module, 5 informational messages are generated for the PSProvideCommentHelp rule indicating that I should provide comment-based help for the 5...
Opengraph URL: https://github.com/PowerShell/PSScriptAnalyzer/issues/199
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"PSProvideCommentHelp should not generate informational messages for functions internal to a module","articleBody":"Today when I run Invoke-ScriptAnalyzer against my DoPx module, 5 informational messages are generated for the PSProvideCommentHelp rule indicating that I should provide comment-based help for the 5 functions that were discovered by this rule. Those are false positives, because the 5 functions in question are internal to my module, not exposed externally at all, and therefore they do not need comment-based help.\n\nThis issue raises another limitation with Invoke-ScriptAnalyzer: today it is written specifically for paths. It should have a parameter set that is for modules, so that you can just pass it a module name and have it analyze the entire module. This is important for a few obvious reasons:\n- modules have their own criteria when it comes to many rules like this one\n- modules have need for rules that are specific to them\n\nWith that in mind, the following changes should be made:\n1. A parameter set should be added to Invoke-ScriptAnalyzer that takes a ModuleInfo parameter (with pipeline input by value) so that you can invoke Get-Module ... | Invoke-ScriptAnalyzer to run it against a module.\n2. A ModuleName parameter set should be added to allow users to invoke Invoke-ScriptAnalyzer -ModuleName ....\n3. The PSProvideCommentHelp rule should not generate messages against functions that are not exported from a module.\n","author":{"url":"https://github.com/KirkMunro","@type":"Person","name":"KirkMunro"},"datePublished":"2015-05-22T19:46:08Z","url":"https://github.com/PowerShell/PSScriptAnalyzer/issues/199"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:84f2cd6c-f724-b2f8-f06e-04f5af28332e |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A102:14BE93:27F3E92:377D122:6AFD4786 |
| html-safe-nonce | 99ae038e029da16bc31dc633c226a166b9e8f43e66497de1bfac40cfdc20103c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBMTAyOjE0QkU5MzoyN0YzRTkyOjM3N0QxMjI6NkFGRDQ3ODYiLCJ2aXNpdG9yX2lkIjoiMjg2NzYwNTIwNDEwOTE4Mjg1NCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 5055cf77767ef59e272f26f8c04a534aa8ac76afc84907271958384b17fe5d78 |
| hovercard-subject-tag | issue:79583817 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/PowerShell/PSScriptAnalyzer/199/issue_layout |
| twitter:image | https://opengraph.githubassets.com/07d2cb9ce0581eabda55db1d28291652f13265856e5ce411e59b76edb8d9138f/PowerShell/PSScriptAnalyzer/issues/199 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/07d2cb9ce0581eabda55db1d28291652f13265856e5ce411e59b76edb8d9138f/PowerShell/PSScriptAnalyzer/issues/199 |
| og:image:alt | Today when I run Invoke-ScriptAnalyzer against my DoPx module, 5 informational messages are generated for the PSProvideCommentHelp rule indicating that I should provide comment-based help for the 5... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | KirkMunro |
| hostname | github.com |
| expected-hostname | github.com |
| None | bdbacc25b921224ff0befcb9e629560a1255be51aec9991d6e3f95b5e9151474 |
| turbo-cache-control | no-preview |
| go-import | github.com/PowerShell/PSScriptAnalyzer git https://github.com/PowerShell/PSScriptAnalyzer.git |
| octolytics-dimension-user_id | 11524380 |
| octolytics-dimension-user_login | PowerShell |
| octolytics-dimension-repository_id | 33149177 |
| octolytics-dimension-repository_nwo | PowerShell/PSScriptAnalyzer |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 33149177 |
| octolytics-dimension-repository_network_root_nwo | PowerShell/PSScriptAnalyzer |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 556dd37bb0aceffb25724e151b5d858b3265b40b |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width