xWaitForADDomain: Fix Issue #341

[RobertCGouge]

Pull Request (PR) description

This PR addresses issue #341. It adds comment based help to the xWaitForADDomain resource.

This Pull Request (PR) fixes the following issues

• Fixes xWaitForADDomain: This resource is missing comment-based help #341

Task list

• Added an entry under the Unreleased section in the CHANGELOG.md.
  Entry should say what was changed, and how that affects users (if applicable).
• Resource documentation added/updated in resource directory README.md.
• Resource parameter descriptions added/updated in schema.mof
  and comment-based help.
• Comment-based help added/updated.
• Localization strings added/updated in all localization files as appropriate.
• Examples appropriately added/updated.
• Unit tests added/updated. See DSC Resource Testing Guidelines.
• Integration tests added/updated (where possible). See DSC Resource Testing Guidelines.
• New/changed code adheres to DSC Resource Style Guidelines and Best Practices.

---

This change is 

[msftclas]

All CLA requirements met.

[codecov-io]

Codecov Report

Merging #435 into dev will not change coverage.
The diff coverage is n/a.

@@         Coverage Diff         @@
##            dev   #435   +/-   ##
===================================
  Coverage    96%    96%           
===================================
  Files        20     20           
  Lines      2599   2599           
  Branches     10     10           
===================================
  Hits       2502   2502           
  Misses       87     87           
  Partials     10     10

[johlju]

Awesome work on this, thank you! 😃 Just one comment.

Reviewed 2 of 2 files at r1.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @RobertCGouge)

---

DSCResources/MSFT_xWaitForADDomain/MSFT_xWaitForADDomain.psm1, line 34 at r1 (raw file):

# The name of the Active Directory domain to wait for.

We should not have these comments above each parameter. Throughout.
These should also be removed/moved if they exist when adding the comment-based help.

[johlju]

@RobertCGouge another thing. if you see the comment lines go over ~80 chars, then please line break them around ~80 chars (not a hard limit), it helps when reviewing. Don't think that was an issue in this resource though, but there will be others, as I'm hoping you want to resolve the others issues as well eventually. 😁
If you use VSCode there is a tool that can be enabled, just add this to your VS Code user settings.

    "editor.rulers": [
        80
    ],

[RobertCGouge]

Thank you for the guidance. I have always thought the best practice was to have the help in both places. I've removed the comments from inside the function and left them in the comment blocks.

[johlju]

@RobertCGouge No worries, happy to help out. Looks like the descriptions above the parameters i Get-TargetResource was not removed. 🙂

Also, when you have resolved the review comments, or if you need to discuss a comment. Could you please go into Reviewable and write 'Done' (or click the done-button) on each of the review comments. This allows me to acknowledge (resolve) the review comments and I know that you are done with each change. After you written 'Done' on each review comment, or comment on the review comment if it needs further discussion, then click the big green 'Publish' button on top of the page. That will send all your comments back as one big comment to this PR.
You find Reviewable if you click on the big purple Reviewable-button in the PR description. 🙂

[RobertCGouge]

Reviewable status: 1 of 2 files reviewed, 1 unresolved discussion (waiting on @johlju)

---

DSCResources/MSFT_xWaitForADDomain/MSFT_xWaitForADDomain.psm1, line 34 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

# The name of the Active Directory domain to wait for.

We should not have these comments above each parameter. Throughout.
These should also be removed/moved if they exist when adding the comment-based help.

Done.

[johlju]

Reviewed 1 of 1 files at r3.
Reviewable status: complete! all files reviewed, all discussions resolved

[johlju]

@RobertCGouge merged! Thank you so much!