Skip to content

Commit cbfa185

Browse files
authored
Minor edit to dev guide section on documentation
1 parent 57a9da4 commit cbfa185

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Guides/Development.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ This will require you to manually provide the path to the compiled test binary (
7070
We document new code as we write it. We use C-style documentation blocks (`/** ... */`) for documentation longer than 3 lines, and triple-slash (`///`) for shorter documentation.
7171
Comments that are _not_ documentation should use two slashes (`//`).
7272

73+
Documentation comments should generally be complete sentences and should end with periods.
74+
7375
Our documentation site is automatically generated from the source code using [Jazzy](https://github.com/realm/jazzy#installation). We regenerate it each time we release a new version of the driver.
7476
To regenerate the files, run `make documentation` from the project's root directory. You can then inspect the changes to the site by opening the files in `/docs` in your web browser.
7577

0 commit comments

Comments
 (0)