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

docs: remove typos and add cspell ignore #3416

Conversation

Shin-kyoto
Copy link
Contributor

@Shin-kyoto Shin-kyoto commented Apr 14, 2023

Description

  • I checked autoware.universe by cspell and got the result below
/home/autoware.universe/localization/ndt_scan_matcher/README.md:231:4 - Unknown word (splitted)
/home/autoware.universe/localization/ndt_scan_matcher/README.md:232:4 - Unknown word (splitted)
/home/autoware.universe/localization/ndt_scan_matcher/README.md:233:4 - Unknown word (splitted)
/home/autoware.universe/localization/pose_initializer/README.md:18:47 - Unknown word (localizar)
/home/autoware.universe/perception/bytetrack/README.md:15:3 - Unknown word (Yifu)
/home/autoware.universe/perception/bytetrack/README.md:15:15 - Unknown word (Peize)
/home/autoware.universe/perception/bytetrack/README.md:15:29 - Unknown word (Jiang)
/home/autoware.universe/perception/bytetrack/README.md:15:36 - Unknown word (Dongdong)
/home/autoware.universe/perception/bytetrack/README.md:15:49 - Unknown word (Fucheng)
/home/autoware.universe/perception/bytetrack/README.md:15:57 - Unknown word (Weng)
/home/autoware.universe/perception/bytetrack/README.md:15:63 - Unknown word (Zehuan)
/home/autoware.universe/perception/bytetrack/README.md:15:101 - Unknown word (Xinggang)
/home/autoware.universe/perception/probabilistic_occupancy_grid_map/README.md:21:17 - Unknown word (paramters)
/home/autoware.universe/planning/behavior_velocity_planner/out-of-lane-design.md:30:110 - Unknown word (relevent) fix: (relevant)
/home/autoware.universe/planning/behavior_velocity_planner/out-of-lane-design.md:31:27 - Unknown word (choosen) fix: (chosen)
/home/autoware.universe/planning/behavior_velocity_planner/out-of-lane-design.md:33:25 - Unknown word (relevent) fix: (relevant)
/home/autoware.universe/planning/freespace_planning_algorithms/README.md:53:57 - Unknown word (fpalgos)
/home/autoware.universe/planning/obstacle_avoidance_planner/docs/debug.md:31:5 - Unknown word (Drivalbe)
/home/autoware.universe/planning/obstacle_avoidance_planner/docs/debug.md:72:10 - Unknown word (obstcle)
/home/autoware.universe/planning/obstacle_avoidance_planner/docs/mpt.md:363:6 - Unknown word (Bibycle)
/home/autoware.universe/perception/image_projection_based_fusion/README.md:43:59 - Unknown word (messge)
/home/autoware.universe/perception/image_projection_based_fusion/README.md:44:63 - Unknown word (messge)
/home/autoware.universe/perception/image_projection_based_fusion/README.md:44:116 - Unknown word (messege)
/home/autoware.universe/perception/lidar_centerpoint/launch/centerpoint_vs_centerpoint-tiny/README.md:133:19 - Unknown word (Boxs)
/home/autoware.universe/vehicle/accel_brake_map_calibrator/accel_brake_map_calibrator/README.md:188:213 - Unknown word (datails)

(note that this is the part of result)

  • So I remove typos from README.md and add cspell ignore in it.

Tests performed

Not applicable.

Effects on system behavior

Not applicable.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

Signed-off-by: Shin-kyoto <58775300+Shin-kyoto@users.noreply.github.com>
@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:localization Vehicle's position determination in its environment. (auto-assigned) component:perception Advanced sensor data processing and environment understanding. (auto-assigned) component:planning Route planning, decision-making, and navigation. (auto-assigned) component:vehicle Vehicle-specific implementations, drivers, packages. (auto-assigned) labels Apr 14, 2023
@Shin-kyoto Shin-kyoto marked this pull request as ready for review April 14, 2023 14:15
@Shin-kyoto Shin-kyoto requested a review from HansRobo April 14, 2023 14:16
Copy link
Contributor

@isamu-takagi isamu-takagi left a comment

Choose a reason for hiding this comment

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

LGTM

@yukkysaito
Copy link
Contributor

@Shin-kyoto Can you change this one too?
image

@Shin-kyoto
Copy link
Contributor Author

Shin-kyoto commented Apr 14, 2023

@Shin-kyoto Can you change this one too? image

@yukkysaito
I plan to add thresholding in tier4/autoware-spell-check-dict#498 because I found thresholding in https://en.wikipedia.org/wiki/Thresholding_(image_processing)

@codecov
Copy link

codecov bot commented Apr 14, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.79 🎉

Comparison is base (780ed9e) 13.16% compared to head (5c085ea) 13.95%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3416      +/-   ##
==========================================
+ Coverage   13.16%   13.95%   +0.79%     
==========================================
  Files        1382     1312      -70     
  Lines       96929    92050    -4879     
  Branches    28012    28180     +168     
==========================================
+ Hits        12756    12845      +89     
+ Misses      70498    65408    -5090     
- Partials    13675    13797     +122     
Flag Coverage Δ *Carryforward flag
differential 12.03% <ø> (?)
total 14.00% <ø> (+0.84%) ⬆️ Carriedforward from 16d7771

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

see 77 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

localization/ndt_scan_matcher/README.md Outdated Show resolved Hide resolved
Copy link
Member

@HansRobo HansRobo left a comment

Choose a reason for hiding this comment

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

All my concerns have been resolved!

@Shin-kyoto
Copy link
Contributor Author

@Shin-kyoto Can you change this one too? image

I plan to add thresholding in tier4/autoware-spell-check-dict#498 because I found thresholding in https://en.wikipedia.org/wiki/Thresholding_(image_processing)

Now thresholding is included in .cspell.json. Check https://github.com/tier4/autoware-spell-check-dict/blob/dc902bb2738451831129e091746dbd03a35b6cf7/.cspell.json#L1560

Signed-off-by: Shin-kyoto <58775300+Shin-kyoto@users.noreply.github.com>
Copy link
Contributor

@kminoda kminoda left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@manato manato left a comment

Choose a reason for hiding this comment

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

@Shin-kyoto
It looks fine regarding perception/bytetrack/README.md. I appreciate your contribution!

@Shin-kyoto Shin-kyoto merged commit dd0779c into autowarefoundation:main Apr 17, 2023
Mingyu1991 pushed a commit to Mingyu1991/autoware.universe that referenced this pull request Jun 26, 2023
* docs: remove typos and add cspell ignore

Signed-off-by: Shin-kyoto <58775300+Shin-kyoto@users.noreply.github.com>

* docs(ndt_scan_matcher): change split files to multiple files

Signed-off-by: Shin-kyoto <58775300+Shin-kyoto@users.noreply.github.com>

---------

Signed-off-by: Shin-kyoto <58775300+Shin-kyoto@users.noreply.github.com>
Signed-off-by: Mingyu Li <mingyu.li@tier4.jp>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:localization Vehicle's position determination in its environment. (auto-assigned) component:perception Advanced sensor data processing and environment understanding. (auto-assigned) component:planning Route planning, decision-making, and navigation. (auto-assigned) component:vehicle Vehicle-specific implementations, drivers, packages. (auto-assigned) type:documentation Creating or refining documentation. (auto-assigned)
Projects
None yet
Development

Successfully merging this pull request may close these issues.