Skip to content

Conversation

pcrumley
Copy link
Contributor

@pcrumley pcrumley commented Jan 6, 2023

This is a slightly opinionated cosmetic refactor of swift-toolbox, and some minor other fixes. Here they are.

  1. Remove default features of chrono to avoid https://rustsec.org/advisories/RUSTSEC-2020-0071.html
  2. Restructure modules to be in name/mod.rs. To me, this style is cleaner, I am happy to revert this change.
  3. Make all doc strings of struct and enums follow rustdoc syntax, so you should be able to see the fields in your favorite IDE & they are properly formatted in the rustdocs. (FYI the way I found them was just run cargo doc --document-private-items and just look over the docs that were created. It was useful to help me get acclimated to this crate anyway. Closes https://swift-nav.atlassian.net/browse/CPP-348
  4. Fix all markdown warning thrown by rustdoc.
  5. Update utils/mod.rs unit tests to use a case based test framework, have the message thrown if test fails be more helpful when comparing floats & byte strings.

Sorry to put these all together, I should have done them as separate PRs.

@swiftnav-travis
Copy link

Frontend and Release Workflow Started here

@swiftnav-travis
Copy link

Frontend and Release Workflow Started here

@pcrumley pcrumley requested a review from adrian-kong January 12, 2023 17:51
Copy link
Contributor

@adrian-kong adrian-kong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

/// Initiates preprocessing of solution data and handles frontend input.
///
/// TODO(johnmichael.burke@) https://swift-nav.atlassian.net/browse/CPP-245
/// TODO(johnmichael.burke@) <https://swift-nav.atlassian.net/browse/CPP-245>
Copy link
Contributor

@adrian-kong adrian-kong Jan 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

think we can remove this and the missing functionalities comment

@swiftnav-travis
Copy link

Frontend and Release Workflow Started here

@pcrumley pcrumley merged commit f2ba9a8 into main Jan 13, 2023
@pcrumley pcrumley deleted the patrick/code-cleanup branch January 13, 2023 01:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants