Skip to content

Commit d607cb3

Browse files
PerelandricSeanTAllen
authored andcommitted
Add note to use code highlighting in docstrings (ponylang#1117)
1 parent c2b271b commit d607cb3

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ When contributing to documentation, try to keep the following style guidelines i
5252

5353
* Wherever possible, try to match the style of surrounding documentation.
5454
* Avoid hard-wrapping lines within paragraphs (using line breaks in the middle of or between sentences to make lines shorter than a certain length). Instead, turn on soft-wrapping in your editor and expect the documentation renderer to let the text flow to the width of the container.
55+
* Apply code highlighting to identifier names, such as types, fields, variables and parameters via the customary markdown syntax of wrapping the name in backticks.
5556

5657
Code Formatting
5758
---------------

0 commit comments

Comments
 (0)