Page 1 of 1

Re-Scan Module?

Posted: Tue May 05, 2015 1:59 pm
by josh a
I'm having a challenge where I update my module but my help file project does not 're-scan' the module to identify that changes to the module have occurred. This could be a parameter change, a parameter set change, or a new function.

How can I get PowerShell HelpWriter to recognize the file has changed? I understand I can start a new help file and have it import the existing settings. However I'm using version control on the help file like a good developer and that process feels wildly unnecessary and bothersome.

Is this possible or did I just create a new feature request?

Running PowerShell HelpWriter 1.0.10

Re-Scan Module?

Posted: Tue May 05, 2015 1:59 pm
by SAPIEN Support Forums
This is an automated post. A real person will respond soon.

Thank you for posting, josh a.

Did you remember to include the following?
  • 1. Product, version and build (e.g. Product: PowerShell Help Writer 2015, Version & Build: 1.0.9. Version and build information can be found in the product's About box accessed by clicking the blue icon with the 'i' in the upper right hand corner of the ribbon.)
    2. Specify if you are running a 32 or 64 bit version
    3. Specify your operating system and if it is 32 or 64 bit.
    4. Attach a screenshot if your issue can be seen on the screen
    5. Attach a zip file if you have multiple files (crash reports, log entries, etc.) related to your issue.
If not, please take a moment to edit your original post or reply to this one.

*** Make sure you do not post any licensing information ***

Re: Re-Scan Module?

Posted: Tue May 05, 2015 8:47 pm
by juneblender
Thanks, Josh. The rescan feature is not yet implemented, but it's high on our planned feature list.

How would you like HelpWriter to respond when the code changes? For example, if a parameter is removed, should it delete your description, or just mark the parameter as deleted?

What if an attribute is changed, like ValueFromPipeline? You'd want to know (or be reminded), because you might want to change your examples.


Re: Re-Scan Module?

Posted: Wed May 06, 2015 11:02 am
by josh a
My vote would be to have the following:
1. Notification in tree navigation of items that have changed
- Green icon and/or text if it is a new item (cmdlet, parameter, parameter set)
- Yellow/Orange icon and/or text if it is a cmdlet that has changes
- Red icon and/or text if it no longer exists in the module.
2. Having a separate view of all the changes identified would be helpful. This could be an output of the rescan process.
3. There should be an automatic scan whenever the help file is loaded.
4. There should be a button to support a manual scan.
5. Should have an option to point the file to compare with a different module. i.e. what happens if I change the module on the system but the help writer isn't loading that new module for some reason.
6. Attribute changes would also be helpful to see.

I'll add another reply to the thread if I think of anything else along these lines.

Re: Re-Scan Module?

Posted: Wed May 06, 2015 6:26 pm
by juneblender
Excellent. Thanks so much for the detail. I'll add it to the feature request that's already in our database.

Please keep the ideas coming. This is a 1.0, so we're counting on you to help us direct future releases.

Re: Re-Scan Module?

Posted: Mon May 11, 2015 9:38 am
by davidc
The manual will be included in the next service release.


Re: Re-Scan Module?

Posted: Tue May 12, 2015 1:23 pm
by josh a
That is excellent news! Thanks!