aurae icon indicating copy to clipboard operation
aurae copied to clipboard

Commitment to documented protos

Open krisnova opened this issue 1 year ago • 0 comments

All fields in the /proto directory such as runtime.proto needs to have full rustdoc compatible documentation, including each field in the messages.

For example. Look at the following INCOMPLETE message.

message StopExecutableRequest {
  string cell_name = 1;
  string executable_name = 2;
}

will need to be updated to the following COMPLETE message.

/// This explains what StopExecutableRequest is used for.
message StopExecutableRequest {
  /// This explains the nuance behind cell_name, and when to use it. Maybe provides an example of what it can be.
  string cell_name = 1;
  /// This explains what an executable_name is and why its different than anything else. When to use it, etc.
  string executable_name = 2;
}

See the official rustdoc for more.

krisnova avatar Dec 29 '22 19:12 krisnova