search

alphaville / optimization-engine

Nonconvex embedded optimization: code generation for fast real-time optimization + ROS support
https://alphaville.github.io/optimization-engine/
Other
499 stars 53 forks source link

added doc check to all .rs files #134

Closed chutchi2 closed 4 years ago

chutchi2 commented 4 years ago

85

Added in rust macro to check docs in all .rs files found in the project.

alphaville commented 4 years ago

@chutchi2 thank you for your contribution. You don't need to include #![deny(missing_docs)] in all files in the project. It suffices to do so in the main lib.rs. We hadn't done so so far because we were planning to remove the continuation module. I have done so in PR #133. Would you like to add #![deny(missing_docs)] and submit a pull request to branch dev/rm-homotopy?

By the way, the unit tests fail. You can run them locally with cargo test.