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.

Sign up for GitHub

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

Jump to bottom

Add AMCL parameter reference page #196

Merged
merged 5 commits into from
May 27, 2023
Merged

Add AMCL parameter reference page #196

merged 5 commits into from
May 27, 2023

Conversation

nahueespinosa
Copy link
Member

@nahueespinosa nahueespinosa commented May 24, 2023 •
edited
Loading

Proposed changes

This is a follow up to #186 (comment). Also related to #85.

Type of change

  • 🐛 Bugfix (change which fixes an issue)
  • 🚀 Feature (change which adds functionality)
  • 📚 Documentation (change which fixes or extends documentation)

Checklist

  • Lint and unit tests (if any) pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • All commmits have been signed for DCO

@nahueespinosa nahueespinosa added documentation Improvements or additions to documentation enhancement New feature or request labels May 24, 2023
@nahueespinosa nahueespinosa self-assigned this May 24, 2023
@nahueespinosa nahueespinosa marked this pull request as ready for review May 24, 2023 21:32
@nahueespinosa nahueespinosa force-pushed the nahuel/add-amcl-parameter-page branch from 82b70b9 to 35c4f31 Compare May 24, 2023 21:41
@hidmic hidmic changed the title Add ACML parameter reference page Add AMCL parameter reference page May 25, 2023
hidmic
hidmic approved these changes May 25, 2023
View reviewed changes
Copy link
Collaborator

@hidmic hidmic left a comment

Choose a reason for hiding this comment

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

This is quite useful @nahueespinosa, even for people using nav2_amcl.

beluga_amcl/docs/PARAMETERS.md Outdated Show resolved Hide resolved
beluga_amcl/docs/PARAMETERS.md Outdated Show resolved Hide resolved
beluga_amcl/docs/PARAMETERS.md Outdated Show resolved Hide resolved
beluga_amcl/docs/PARAMETERS.md Show resolved Hide resolved
glpuga
glpuga reviewed May 25, 2023
View reviewed changes
Copy link
Collaborator

@glpuga glpuga left a comment

Choose a reason for hiding this comment

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

Great work! I left some comments.

beluga_amcl/README.md Outdated Show resolved Hide resolved
beluga_amcl/README.md Outdated Show resolved Hide resolved
beluga_amcl/docs/PARAMETERS.md Outdated Show resolved Hide resolved
beluga_amcl/docs/PARAMETERS.md Outdated Show resolved Hide resolved
beluga_amcl/docs/PARAMETERS.md Outdated Show resolved Hide resolved
beluga_example/config/params.yaml Outdated Show resolved Hide resolved
@nahueespinosa
Add ACML parameter reference page
dc88386 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Address code review comments
b0672a7 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa
Revert changes to params.yaml
b470a18 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa nahueespinosa force-pushed the nahuel/add-amcl-parameter-page branch from 35c4f31 to b470a18 Compare May 26, 2023 14:42
@nahueespinosa
Copy link
Member Author

@glpuga @hidmic Thanks for your reviews! This is ready for a second pass.

@nahueespinosa
Fix mistakes
d5bdd22 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
glpuga
glpuga approved these changes May 26, 2023
View reviewed changes
Copy link
Collaborator

@glpuga glpuga left a comment

Choose a reason for hiding this comment

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

LGTM!

beluga_amcl/docs/PARAMETERS.md Outdated Show resolved Hide resolved
beluga_amcl/docs/PARAMETERS.md Outdated Show resolved Hide resolved
@nahueespinosa nahueespinosa force-pushed the nahuel/add-amcl-parameter-page branch from 83fafee to be9d1c3 Compare May 27, 2023 02:26
@nahueespinosa
Add compatibility notes and address comments
7968474 
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
@nahueespinosa nahueespinosa force-pushed the nahuel/add-amcl-parameter-page branch from be9d1c3 to 7968474 Compare May 27, 2023 02:29
@nahueespinosa nahueespinosa merged commit 62ca3ad into main May 27, 2023
5 checks passed
@nahueespinosa nahueespinosa deleted the nahuel/add-amcl-parameter-page branch May 27, 2023 02:47
@nahueespinosa nahueespinosa mentioned this pull request May 27, 2023
Closed
52 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glpuga glpuga glpuga approved these changes

@ivanpauno ivanpauno Awaiting requested review from ivanpauno

@hidmic hidmic Awaiting requested review from hidmic

Assignees

@nahueespinosa nahueespinosa

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@nahueespinosa @hidmic @glpuga