Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(autoware_universe_utils): update document #7907

Merged
merged 8 commits into from
Jul 12, 2024

Conversation

yhisaki
Copy link
Contributor

@yhisaki yhisaki commented Jul 9, 2024

Description

  • Changed the example from a script format to a format where nodes are held as objects.
  • Recommended the use of ScopedTimeTrack.
  • Modified the example to pass the reporter in the constructor and provided an example of using add_report() in the comments.
  • Added comments indicating the start and end timing of the tree construction, as well as the timing of the reporting.
  • Remove String reporter.

Related links

How was this PR tested?

Notes for reviewers

None.

Interface changes

None.

Effects on system behavior

None.

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>
@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:common Common packages from the autoware-common repository. (auto-assigned) labels Jul 9, 2024
Copy link

github-actions bot commented Jul 9, 2024

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>
@yhisaki yhisaki added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jul 11, 2024
Copy link

codecov bot commented Jul 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.94%. Comparing base (b1eeb68) to head (0822435).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7907   +/-   ##
=======================================
  Coverage   28.94%   28.94%           
=======================================
  Files        1600     1601    +1     
  Lines      117232   117227    -5     
  Branches    50299    50297    -2     
=======================================
+ Hits        33933    33935    +2     
+ Misses      74150    74144    -6     
+ Partials     9149     9148    -1     
Flag Coverage Δ *Carryforward flag
differential 30.30% <100.00%> (?)
total 28.94% <ø> (+<0.01%) ⬆️ Carriedforward from b1eeb68

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

yhisaki and others added 3 commits July 12, 2024 11:35
Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>
Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>
#include <iostream>
#include <memory>
#include <thread>

class TimeKeeperExample : public rclcpp::Node
Copy link
Contributor

@takayuki5168 takayuki5168 Jul 12, 2024

Choose a reason for hiding this comment

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

ExampleNode instead of TimeKeeperExample sounds better since the word TimeKeeper is everywhere currently and searchability is not so high.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed!

yhisaki added 3 commits July 12, 2024 15:20
Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>
Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>
Copy link
Contributor

@takayuki5168 takayuki5168 left a comment

Choose a reason for hiding this comment

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

LGTM!

@yhisaki yhisaki enabled auto-merge (squash) July 12, 2024 06:30
@yhisaki yhisaki merged commit 7de0ec0 into autowarefoundation:main Jul 12, 2024
22 of 24 checks passed
yhisaki added a commit to tier4/autoware.universe that referenced this pull request Jul 19, 2024
)

* update readme

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

* refactoring

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

* remove string reporter

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

* fix readme.md

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

* change node name of example

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

* update readme

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

---------

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>
Ariiees pushed a commit to Ariiees/autoware.universe that referenced this pull request Jul 22, 2024
)

* update readme

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

* refactoring

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

* remove string reporter

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

* fix readme.md

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

* change node name of example

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

* update readme

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>

---------

Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>
@yhisaki yhisaki deleted the update-time_keeper-document branch July 31, 2024 04:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:common Common packages from the autoware-common repository. (auto-assigned) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants