Skip to content

Commit 0752a52

Browse files
committed
update doc for embedded markdown fixes
1 parent 3228546 commit 0752a52

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/sp_doc.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff 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+
8991
Add extended properties to programmable objects, using parameter names as keys,
9092
to 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

102116
Sample output for the [WideWorldImporters database][sample].

0 commit comments

Comments
 (0)