Make example conform to its rule in style guide (metalbear-co#1990)

* Style guide example * changelog
Razz4780 · Oct 6, 2023 · a5488d5 · a5488d5
1 parent 784b743
commit a5488d5
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/STYLE.md b/STYLE.md
@@ -2,7 +2,7 @@
 
 ## Rust
 
-- When naming Senders and Receivers, use a_tx and b_rx respectively - where a is the thing the Sender is sending, and b is the thing Receiver is receiving. e.g. agent_message_sender, http_response_receiver.
+- When naming Senders and Receivers, use `a_tx` and `b_rx` respectively - where `a` is the thing the Sender is sending, and `b` is the thing Receiver is receiving. E.g. `agent_message_tx`, `http_response_rx`.
     - Document above the declaration of the variable/struct member what’s being sent from where to where. Suggested format:
       `<src> --<what's being sent>—> <dst>`.
 

diff --git a/changelog.d/+style_example.internal.md b/changelog.d/+style_example.internal.md
@@ -0,0 +1 @@
+Example in style guide conforms with the rule it's supposed to explain.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Example in style guide conforms with the rule it's supposed to explain.