From 0c5a5ca45fe6feef76875f297d20b06a30657edc Mon Sep 17 00:00:00 2001 From: Byoungchan Lee Date: Thu, 8 Jul 2021 09:00:19 +0900 Subject: [PATCH] doc: using triple backticks instead of
 blocks

While 
 HTML tag blocks are allowed in both commonmark specification
and commonmark-java, for some reason,
webrtc.googlesource.com using gitiles doesn't render that block. [1]
It's probably because of the stricter conditions of the gitiles HTML
extension. [2]
So use a much more portable code block syntax (triple backticks).

[1] https://webrtc.googlesource.com/src/+/5900ba0ee8f3f9cef3b29becbb4335b8f440d57d/api/g3doc/threading_design.md
[2] https://gerrit.googlesource.com/gitiles/+/f65ff3b7bfc36f8426aa0199220b111e14ff92ee/java/com/google/gitiles/doc/GitilesHtmlExtension.java#32

Bug: None
Change-Id: Ie83bbb7e26dec5225cd79b926b97529e33a37149
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/225360
Reviewed-by: Harald Alvestrand 
Commit-Queue: Harald Alvestrand 
Cr-Commit-Position: refs/heads/master@{#34433}
---
 api/g3doc/threading_design.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/api/g3doc/threading_design.md b/api/g3doc/threading_design.md
index 868c433abc..20c3539b22 100644
--- a/api/g3doc/threading_design.md
+++ b/api/g3doc/threading_design.md
@@ -37,7 +37,7 @@ and sequenced task queues.
 At the moment, the API does not give any guarantee on which thread* the
 callbacks and events are called on. So it's best to write all callback
 and event handlers like this (pseudocode):
-
+```
 void ObserverClass::Handler(event) {
   if (!called_on_client_thread()) {
     dispatch_to_client_thread(bind(handler(event)));
@@ -45,7 +45,7 @@ void ObserverClass::Handler(event) {
   }
   // Process event, we're now on the right thread
 }
-
+``` In the future, the implementation may change to always call the callbacks and event handlers on the client thread.