message_filters
message_filters copied to clipboard
ros2
Extend Tutorials Section
As per the title we could keep expanding the tutorials section of our message_filters documentation because you can never have enough documentation. Specifically https://github.com/ros2/message_filters/pull/119#discussion_r1604565909 specifies for us to add an ApproximateEpsilonTime tutorials. That being said the following policies and objects could technically have their own tutorials:
- [ ] ApproximateEpsilonTime (C++)
- [ ] LatestTime (C++)
- [ ] Chain (C++)
- [ ] Cache (C++)
- [ ] Cache (Python)
Possibly:
- [ ] Custom Simple Filter (C++ - Intermediate)
- [ ] Custom Simple Filter (Python - Intermediate)
I should be able to get to most of these relatively fast, but they should be in one location ready for tracking. Additionally since most of tfhe documentation is hosted on message_filters this shouldn't need to go to ros2_documentation
/label help-wanted @ahcorde can you add the label, cz i do not have power to do that.
Is someone working on this one? If nobody is, is it ok, If I try to add at least some of them?
Looking for some issues to work on in some spare time. 🙂
upd
I've started with the Cache filter for Python, as I've worked with lately. If anybody is OK with it.
Hey @EsipovPA, I have not been able to get to this, maybe the issue will end up being assigned to you. The more the merrier.
Added the PR for Python Cache filter. Start working on C++ tutorial for the same filter.
upd
To add tutorial with String for Cache filter in Cpp, it will require the Cache filter to caching headerless messages. This change is suggested in this issue: #74. I'll try to tackle it in the PR with the tutorial itself.
Seems like there is an issue with "Build your package" section in tutorial for Cache (Python). Not sure about the possible solutions.
I thik this issue is not closed yet. I've added only one tutorial and working on them one by one. Is it possible to reopen this issue? @CursedRock17, @ahcorde
@EsipovPA i would agree there's still lots to do, I did mark off the Cache filter in the tasks list though.
@CursedRock17. I think we may check the Cache (C++) checkmark. Started working on Chain filter tutorial. BTW, shoudn't we add the same filter for Python? Did not look at the code yet, sorry if this is a stupid question.
@EsipovPA awesome! As for why there's no Chain class in Python is beyond me, it looks like that C file was last changed 7 years ago and it's probably just overlooked since. If you haven't started on it, I could work on the class implementaiton + tutorial all in Python some time this weekend.
Hey everyone!
I was out of town for the last couple of weeks with my family, and will be out of town again for the two weeks, starting the 4th of august.
After that, will get back to work on this issue.
Hello everyone! I've added a PR with a new tutorial for the Chain filter. I would be great if anyone could review it!
I think I might turn to adding a Python implementation for the Chain filter, as it is missing. And with that I'll try to add a tutorial for that as well.
I've also noticed that there is some problem with Build your package section in the Cache tutorial both for C++ and Python. But when I build documentation locally, I do not see this problem. Maybe the environment where the documentation is build for web-page lacks python3-sphinx-tabs package? I've had some issues with the absence of that specific package, when I was building the documentation locally for the first time.
The left part of the image is my local build and the right one is from the web-page
I think this issue is not completely closed. Maybe reopen it again? And add a checkmark for Chain (C++)?
