File tree Expand file tree Collapse file tree 1 file changed +14
-0
lines changed Expand file tree Collapse file tree 1 file changed +14
-0
lines changed Original file line number Diff line number Diff line change @@ -86,6 +86,8 @@ Invoke-DbaQuery -SqlInstance localhost -Database master -Query $Query -As Single
8686
8787### Advanced Use
8888
89+ #### Stored Procedure Parameters
90+
8991Add extended properties to programmable objects, using parameter names as keys,
9092to include their descriptions in the documentation:
9193
@@ -97,6 +99,18 @@ EXEC sys.sp_addextendedproperty @name=N'@ExtendedPropertyName',
9799 @level1name=N'sp_doc'
98100```
99101
102+ #### Embedded Markdown
103+
104+ Extended properties containing embedded markdown are supported. The following characters
105+ are replaced to render markdown as plain text to avoid issues with formatting:
106+
107+ | Character | Replacement | Description |
108+ | --------- | ----------- | ----------- |
109+ | ` \| ` | ` | ` | HTML code for pipe |
110+ | ``` ` ``` | ` ` ` | HTML code for tick |
111+ | ` Newline ` | ` <br/> ` | HTML tag for line break |
112+
113+
100114## Output
101115
102116Sample output for the [ WideWorldImporters database] [ sample ] .
You can’t perform that action at this time.
0 commit comments