[tor-commits] [tor/master] Note in the rust doc that these comments are bidirectional

[nickm at torproject.org]

commit ebcd1a57c0f784d97bfebfc071dffbd0bff93ec8
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Nov 13 10:04:40 2017 -0500

    Note in the rust doc that these comments are bidirectional
---
 doc/HACKING/GettingStartedRust.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/HACKING/GettingStartedRust.md b/doc/HACKING/GettingStartedRust.md
index 7d8a74bfe..181535122 100644
--- a/doc/HACKING/GettingStartedRust.md
+++ b/doc/HACKING/GettingStartedRust.md
@@ -131,7 +131,9 @@ as follows:
 
   /// C_RUST_COUPLED: <path_to_file> `<name_of_c_object>`
 
-Where <name_of_c_object> can be an enum, struct, constant, etc.
+Where <name_of_c_object> can be an enum, struct, constant, etc.  Then, do the
+same in the C code, to note that rust will need to be changed when the C
+does.
 
  Adding your Rust module to Tor's build system
 -----------------------------------------------