diff options
| author | Guinness <guinness@crans.org> | 2020-07-13 11:16:51 +0200 |
|---|---|---|
| committer | Guinness <guinness@crans.org> | 2020-07-13 11:45:14 +0200 |
| commit | b119c5577678b14f320a1a5cd58d8f591cb3084d (patch) | |
| tree | 8550b00c143ce630b5ff8d5e9feee43e25e17643 /doc/HACKING/Module.md | |
| parent | 8ebbf629404a97b6110c1916d554009dc8f42c5a (diff) | |
| download | tor-b119c5577678b14f320a1a5cd58d8f591cb3084d.tar.gz tor-b119c5577678b14f320a1a5cd58d8f591cb3084d.zip | |
Syntax highlighting in the docs
This adds the syntax highlights in the MarkDown files.
Fixes #33741
Diffstat (limited to 'doc/HACKING/Module.md')
| -rw-r--r-- | doc/HACKING/Module.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/HACKING/Module.md b/doc/HACKING/Module.md index f8a9773d47..b9d3a654eb 100644 --- a/doc/HACKING/Module.md +++ b/doc/HACKING/Module.md @@ -70,7 +70,7 @@ There are couples of "rules" you want to follow: base. Every entry point should have a second definition if the module is disabled. For instance: - ``` + ```c #ifdef HAVE_MODULE_DIRAUTH int sr_init(int save_to_disk); @@ -109,7 +109,9 @@ There are couples of "rules" you want to follow: * When you include headers from the module, **always** use the full module path in your statement. Example: - `#include "feature/dirauth/dirvote.h"` +```c +#include "feature/dirauth/dirvote.h"` +``` The main reason is that we do **not** add the module include path by default so it needs to be specified. But also, it helps our human brain understand |