[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
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

Move Docs From Wiki #119

Merged
merged 16 commits into from
May 27, 2024
Merged

Move Docs From Wiki #119

merged 16 commits into from
May 27, 2024

Conversation

CursedRock17
Copy link
Contributor
@CursedRock17 CursedRock17 commented May 4, 2024 •
edited
Loading

As per the title, this pull request moves the documentation of message_filters over to docs.ros.org from the WIKI, fully updated to fit current ROS 2 stadards. Furthermore, this pr contians new, in-depth tutorials for users to get better with message_filters and understand the various filters and policies. That part of the pull request comes from both this ros2_documentation issue and this ros2_documentation issue in which the tutorials needed an update. So, I added those tutorials over here so the docs would be centralized and only people using the package would have to worry about it, but if we needed, we can just copy all the information over to a PR in that repo. Additionally, I cannot get the ros2 docs to work for Python, though it works in C++, it comes from this line: https://github.com/CursedRock17/message_filters/blob/66c6bf9230c95cecc87c974500d759772a4e16de/doc/index.rst?plain=1#L263

@CursedRock17 CursedRock17 marked this pull request as ready for review May 5, 2024 17:54
@CursedRock17 CursedRock17 requested a review from gbiggs as a code owner May 5, 2024 17:54
ahcorde
ahcorde requested changes May 17, 2024
View reviewed changes
doc/index.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/Tutorials/Approximate-Synchronizer-Python.rst Outdated Show resolved Hide resolved
doc/Tutorials/Approximate-Synchronizer-Python.rst Outdated Show resolved Hide resolved
doc/Tutorials/Writing-A-Time-Synchronizer-Cpp.rst Outdated Show resolved Hide resolved
@CursedRock17
Copy link
Contributor Author

I've added those necessary changes but when it comes to this comment, we're looking to do a whole other Pull request for those tutorials after this one gets merged correct? Also, should I add a section for the latest_time policy as well?

ahcorde
ahcorde approved these changes May 20, 2024
View reviewed changes
Copy link
Contributor
@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

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

  • Linux Build Status
  • Linux-aarch64 Build Status
  • Windows Build Status

@ahcorde
Copy link
Contributor
ahcorde commented May 20, 2024

I've added those necessary changes but when it comes to this comment, we're looking to do a whole other Pull request for those tutorials after this one gets merged correct? Also, should I add a section for the latest_time policy as well?

Yes, we should add these new changes in a new PR

ahcorde
ahcorde requested changes May 20, 2024
View reviewed changes
Copy link
Contributor
@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

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

do you mind to fix the conflict ?

@CursedRock17
Moving Docs from Wiki
5337dcc 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
@CursedRock17
Moving stuff
295d41b 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>

Additional move

Signed-off-by: CursedRock17 <mtglucas1@gmail.com>

Playing around

Signed-off-by: CursedRock17 <mtglucas1@gmail.com>

Adding full tutorials

Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
@CursedRock17
Better Tutorials and API
f022016 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
@CursedRock17
Adding code inserts
cb52771 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
@CursedRock17
Fixing merge conflict
ffc0b51 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
@CursedRock17
Moving Docs from Wiki
9119c39 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
@CursedRock17
Revert "Adding Copyright Linter (ros2#122)"
5b77c8d 
This reverts commit 84fa246.
@CursedRock17
Fixing merge conflicts
ba0bad7 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>

Additional

Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
@CursedRock17
conf.py changes
2145977 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
ahcorde
ahcorde requested changes May 21, 2024
View reviewed changes
Copy link
Contributor
@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

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

I can see these errors:

/home/ahcorde/ros2_rolling/src/ros2/message_filters/doc/Tutorials/Approximate-Synchronizer-Cpp.rst:1: ERROR: Unknown directive type "redirect-from".

.. redirect-from::

   Tutorials/Approximate-Synchronizer-Cpp
/home/ahcorde/ros2_rolling/src/ros2/message_filters/doc/Tutorials/Approximate-Synchronizer-Python.rst:1: ERROR: Unknown directive type "redirect-from".

.. redirect-from::

   Tutorials/Approximate-Synchronizer-Python
/home/ahcorde/ros2_rolling/src/ros2/message_filters/doc/Tutorials/Writing-A-Time-Synchronizer-Cpp.rst:1: ERROR: Unknown directive type "redirect-from".

.. redirect-from::

   Tutorials/Writing-A-Time_Synchronizer-Cpp
/home/ahcorde/ros2_rolling/src/ros2/message_filters/doc/Tutorials/Writing-A-Time-Synchronizer-Python.rst:1: ERROR: Unknown directive type "redirect-from".

.. redirect-from::

   Tutorials/Writing-A-Time_Synchronizer-Python

In the index.html I can't see any link to the tutorials or API links

@CursedRock17
Fixing Tutorial issues
b57e30a 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
@CursedRock17
Copy link
Contributor Author

Yeah I messed up the index.rst file when I was dealing with the merge conflict, added in an extra one somehow. Turns out those redirects were useless so I removed those and created a singular, correct index file. Though now I've got all the updated code in the pull request, so I assume I need to remove in order to have a nice PR.

@ahcorde
Copy link
Contributor
ahcorde commented May 27, 2024
  • Linux Build Status
  • Linux-aarch64 Build Status
  • Windows Build Status

ahcorde
ahcorde requested changes May 27, 2024
View reviewed changes
Copy link
Contributor
@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

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

linters are failing

@CursedRock17
Fixing Diff
58f4234 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>

Fix

Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
CursedRock17 and others added 4 commits May 27, 2024 11:17
@CursedRock17
Cleanup
8f38046 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
@CursedRock17
Update __init__.py
fc6b0b4 
Signed-off-by: Lucas Wendland <82680922+CursedRock17@users.noreply.github.com>
@CursedRock17
Update subscriber.h whitespace
b8453cf 
Signed-off-by: Lucas Wendland <82680922+CursedRock17@users.noreply.github.com>
@CursedRock17
Update latest_time.h whitespace
f403c19 
Signed-off-by: Lucas Wendland <82680922+CursedRock17@users.noreply.github.com>
@CursedRock17
Merge branch 'rolling' into move_from_wiki
d147c39 
Signed-off-by: Lucas Wendland <82680922+CursedRock17@users.noreply.github.com>
@CursedRock17
Copy link
Contributor Author

I don't know what I had done before with my rebase but it completely messed up the last few commits, all the linters pass now and we shouldn't have any CI problems, additionally all the tutorial links work

@ahcorde
Copy link
Contributor
ahcorde commented May 27, 2024
  • Linux Build Status
  • Linux-aarch64 Build Status
  • Windows Build Status

@ahcorde ahcorde merged commit 9be9813 into ros2:rolling May 27, 2024
2 checks passed
@CursedRock17 CursedRock17 deleted the move_from_wiki branch May 27, 2024 21:45
@CursedRock17 CursedRock17 mentioned this pull request Jun 8, 2024
Open
7 tasks
@ivrolan ivrolan mentioned this pull request Jun 27, 2024
Merged
ahcorde pushed a commit that referenced this pull request Dec 12, 2024
@CursedRock17 @ahcorde
Move Docs From Wiki (#119)
2389325 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
Signed-off-by: Lucas Wendland <82680922+CursedRock17@users.noreply.github.com>
ahcorde pushed a commit that referenced this pull request Dec 12, 2024
@CursedRock17 @ahcorde
Move Docs From Wiki (#119)
1ff0ff2 
Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
Signed-off-by: Lucas Wendland <82680922+CursedRock17@users.noreply.github.com>
ahcorde added a commit that referenced this pull request Dec 12, 2024
@mergify @CursedRock17 @ahcorde
Move from Wiki and Updated Python docs (backport #150) (#152)
457bcd6 
* Move Docs From Wiki (#119)

Signed-off-by: CursedRock17 <mtglucas1@gmail.com>
Signed-off-by: Lucas Wendland <82680922+CursedRock17@users.noreply.github.com>
Signed-off-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Co-authored-by: Lucas Wendland <82680922+CursedRock17@users.noreply.github.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ahcorde ahcorde ahcorde requested changes

@gbiggs gbiggs Awaiting requested review from gbiggs

Assignees

@clalancette clalancette

@gbiggs gbiggs

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@CursedRock17 @ahcorde @clalancette @gbiggs