{"action":"closed","issue":{"url":"https://api.github.com/repos/PowerShell/platyPS/issues/36","repository_url":"https://api.github.com/repos/PowerShell/platyPS","labels_url":"https://api.github.com/repos/PowerShell/platyPS/issues/36/labels{/name}","comments_url":"https://api.github.com/repos/PowerShell/platyPS/issues/36/comments","events_url":"https://api.github.com/repos/PowerShell/platyPS/issues/36/events","html_url":"https://github.com/PowerShell/platyPS/issues/36","id":146434412,"number":36,"title":"Add help.xml proper naming convention cmdlet to PlatyPs","user":{"login":"jongeller","id":660502,"avatar_url":"https://avatars.githubusercontent.com/u/660502?v=3","gravatar_id":"","url":"https://api.github.com/users/jongeller","html_url":"https://github.com/jongeller","followers_url":"https://api.github.com/users/jongeller/followers","following_url":"https://api.github.com/users/jongeller/following{/other_user}","gists_url":"https://api.github.com/users/jongeller/gists{/gist_id}","starred_url":"https://api.github.com/users/jongeller/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jongeller/subscriptions","organizations_url":"https://api.github.com/users/jongeller/orgs","repos_url":"https://api.github.com/users/jongeller/repos","events_url":"https://api.github.com/users/jongeller/events{/privacy}","received_events_url":"https://api.github.com/users/jongeller/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/PowerShell/platyPS/labels/enhancement","name":"enhancement","color":"84b6eb"}],"state":"closed","locked":false,"assignee":{"login":"jongeller","id":660502,"avatar_url":"https://avatars.githubusercontent.com/u/660502?v=3","gravatar_id":"","url":"https://api.github.com/users/jongeller","html_url":"https://github.com/jongeller","followers_url":"https://api.github.com/users/jongeller/followers","following_url":"https://api.github.com/users/jongeller/following{/other_user}","gists_url":"https://api.github.com/users/jongeller/gists{/gist_id}","starred_url":"https://api.github.com/users/jongeller/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jongeller/subscriptions","organizations_url":"https://api.github.com/users/jongeller/orgs","repos_url":"https://api.github.com/users/jongeller/repos","events_url":"https://api.github.com/users/jongeller/events{/privacy}","received_events_url":"https://api.github.com/users/jongeller/received_events","type":"User","site_admin":false},"milestone":null,"comments":2,"created_at":"2016-04-06T21:03:04Z","updated_at":"2016-05-10T18:46:59Z","closed_at":"2016-05-10T18:46:59Z","body":"Add a cmdlet to PlatyPs the properly names a help.xml file for use.\r\nHelp files need to be specifically named in order for the PowerShell help engine to find them. There must be a help file corresponding to each cmdlet-providing code file, DLL, CDXML, PSM1.\r\n\r\n# New Functionality - Format-PlatyPsHelpXml\r\nThis cmdlet will take the name of a file that contains the code for a Powershell module's cmdlets. It will also take in the source help.xml file. Using these two things, the cmdlet will generate a help.xml file that is properly named and can be consumed by the PowerShell help engine.\r\n\r\n## Required Params\r\n```powershell\r\n[Cmdletbinding()]\r\n    param(\r\n        [parameter(Mandatory=$true)]\r\n        [string] $HelpFileSourceXml,\r\n        [parameter(Mandatory=$true)]\r\n        [string] $ModuleFileName,\r\n        [parameter(Mandatory=$true)]\r\n        [string] $Destination\r\n    )\r\n```\r\n\r\n## File naming convention\r\nThe help system in PowerShell requires that help.xml files have a specific name scheme in order for  ```Get-Help```  to find the documentation and display it in the help console. \r\n\r\n```\r\n<ModuleCodeFileName>-help.xml\r\n```"}}