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

Added Columns, Improved readability for ToC. #1307

Merged
merged 3 commits into from
May 2, 2018
Merged

Added Columns, Improved readability for ToC. #1307

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b3a387
Improved readability.
st0le May 1, 2018
cf54c5e
Fixed anchor link for assert-mock
st0le May 1, 2018
9f501d3
Fixed the missed instances.
st0le May 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions docs/community_snippets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@ _To contribute, check out our [guide here](#contributing)._

## Table of contents

| Table of Contents |
|:------------------|
| [AssertMock](#assert_mock): _Creates assert mock Pester test_ |
| [AWSRegionDynamicParameter](#awsregiondynamicparameter): _Creates a dynamic parameter of current AWS regions by @jbruett_ |
| [CalculatedProperty](#calculatedproperty): _Create a calculated property for use in a select-object call by @corbob_ |
| [DataTable](#datatable): _Creates a DataTable_ |
| [DateTimeWriteVerbose](#datetimewriteverbose): _Write-Verbose with the time and date pre-pended to your message by @ThmsRynr_ |
| [Error-Terminating](#error-terminating): _Create a full terminating error by @omniomi_ |
| [IfShouldProcess](#ifshouldprocess): _Added If Should Process_ |
| [MaxColumnLengthinDataTable](#maxcolumnlengthindatatable): _Gets the max length of string columns in datatables_ |
| [Parameter-Credential](#parameter-credential): _Add a standard credential parameter to your function by @omniomi_ |
| [PesterTestForMandatoryParameter](#pestertestformandatoryparameter): _Create Pester test for a mandatory parameter_ |
| [PesterTestForParameter](#pestertestforparameter): _Create Pester test for parameter_ |
| [PSCustomObject](#pscustomobject): _A simple PSCustomObject by @brettmillerb_ |
| Snippet name | Description |
| --------- | ---------|
| [AssertMock](#assert-mock) | _Creates assert mock Pester test_ |
| [AWSRegionDynamicParameter](#awsregiondynamicparameter) | _Creates a dynamic parameter of current AWS regions by @jbruett_ |
| [CalculatedProperty](#calculatedproperty) | _Create a calculated property for use in a select-object call by @corbob_ |
| [DataTable](#datatable) | _Creates a DataTable_ |
| [DateTimeWriteVerbose](#datetimewriteverbose) | _Write-Verbose with the time and date pre-pended to your message by @ThmsRynr_ |
| [Error-Terminating](#error-terminating) | _Create a full terminating error by @omniomi_ |
| [IfShouldProcess](#ifshouldprocess) | _Added If Should Process_ |
| [MaxColumnLengthinDataTable](#maxcolumnlengthindatatable) | _Gets the max length of string columns in datatables_ |
| [Parameter-Credential](#parameter-credential) | _Add a standard credential parameter to your function by @omniomi_ |
| [PesterTestForMandatoryParameter](#pestertestformandatoryparameter) | _Create Pester test for a mandatory parameter_ |
| [PesterTestForParameter](#pestertestforparameter) | _Create Pester test for parameter_ |
| [PSCustomObject](#pscustomobject) | _A simple PSCustomObject by @brettmillerb_ |

## Snippets

Expand Down Expand Up @@ -302,20 +302,20 @@ You need to add an item to the table of contents. The addition should follow the
The ToC item template looks like this:

```md
| [Name of snippet](link to header of your snippet): _some short description_ |
| [Name of snippet](link to header of your snippet) | _some short description_ |
```

An example looks like this (NOTE: all lowercase link):

```md
| [PSCustomObject](#pscustomobject): _A simple PSCustomObject_ |
| [PSCustomObject](#pscustomobject) | _A simple PSCustomObject_ |
```

which will show up in the ToC like this:

| Table of Contents |
|:------------------|
| [PSCustomObject](#pscustomobject): _A simple PSCustomObject_ |
| Snippet Name | Description |
|--------- | ---------|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also one more change to this a little bit higher up on line 305. Can you also fix that one?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed that. I've fixed it.

| [PSCustomObject](#pscustomobject) | _A simple PSCustomObject_ |

### Body

Expand Down