Browse Source

Note in the rust doc that these comments are bidirectional

Nick Mathewson 6 years ago
parent
commit
ebcd1a57c0
1 changed files with 3 additions and 1 deletions
  1. 3 1
      doc/HACKING/GettingStartedRust.md

+ 3 - 1
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
 -----------------------------------------------