digital-asset/daml
1
1
Fork 0
mirror of https://github.com/digital-asset/daml.git synced 2024-09-20 01:07:18 +03:00
Code Issues Projects Releases Wiki Activity

add tip about blank line before lists (#16248)

Browse Source 
Add information to docs README to make sure there are two carriage returns before lists.

[CHANGELOG_BEGIN]
[CHANGELOG_END]
This commit is contained in:
Lois Kilberg 2023-02-07 10:41:39 -05:00 committed by GitHub
parent 2a0446f13c
commit bc3c2595b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/README.md
View File

@ -59,6 +59,7 @@ If you’re not familiar, it’s really worth reading the [primer](http://www.sp
""""""
```
- For internal links, use the `doc` directive where you can.
- Before any lists in an .rst file, be sure to add an extra blank line. There should be two carriage returns between the text that comes before a list and the list itself. Otherwise, the list items will all be merged into a single paragraph.
- For bullet points (unordered lists), use `-` (dashes).
- For code blocks, use the `literalinclude` directive if you can: it's best to source code from files that we test whether they compile.