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.

Sign up for GitHub

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

Jump to bottom

SqlServerDsc: Fix comment-based help formatting throughout #1500

Closed
johlju opened this issue Apr 16, 2020 · 0 comments · Fixed by #1587
Closed

SqlServerDsc: Fix comment-based help formatting throughout #1500

johlju opened this issue Apr 16, 2020 · 0 comments · Fixed by #1587
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub

Comments

@johlju
Copy link
Member

johlju commented Apr 16, 2020

For example

<#
    .SYNOPSIS
    Tests if the permissions is set for the user in the database.

    .PARAMETER Ensure
    This is The Ensure if the permission should be granted (Present) or revoked (Absent).
#>

Should be formatted like

<#
    .SYNOPSIS
        Tests if the permissions is set for the user in the database.

    .PARAMETER Ensure
        This is The Ensure if the permission should be granted (Present) or revoked (Absent).
#>
@johlju johlju added documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub help wanted The issue is up for grabs for anyone in the community. labels Apr 16, 2020
johlju added a commit to johlju/SqlServerDsc that referenced this issue Jul 7, 2020
@johlju
SqlServerDsc: Updated comment-based help (issue dsccommunity#1500)
ebaa493
@johlju johlju mentioned this issue Jul 7, 2020
Merged
9 tasks
johlju added a commit that referenced this issue Jul 9, 2020
@johlju
SqlServerDsc: Updated comment-based help (issue #1500) (#1587)
359104f 
- SqlServerDsc
  - Updated comment-based help according to style guideline throughout
    (issue #1500).
@johlju johlju removed the help wanted The issue is up for grabs for anyone in the community. label Jul 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

SqlServerDsc: Updated comment-based help (issue #1500) johlju/SqlServerDsc
1 participant
@johlju