ros / geometry

Packages for common geometric calculations including the ROS transform library, "tf". Also includes ROS bindings for "bullet" physics engine and "kdl" kinematics/dynamics package.
173 stars 274 forks source link

Where's the official Python API documentation for TF? #161

Closed nbro closed 6 years ago

nbro commented 6 years ago

Please, see the following question: https://answers.ros.org/question/287826/wheres-the-official-python-api-documentation-for-tf/.

In a nutshell, I think, it's quite difficult to find the documentation for the Python API for TF (Is even there such thing as "Python API for TF"? It's not understandable! I have to look at the source code, which is unacceptable!), the documentation is poorly written or quite incomplete.

I think this is a big issue which should be solved as soon as possible. Nowadays, it's quite unacceptable that people have to spend 30 minutes to find the documentation of a method and another 30 minutes to understand what it does because the documentation doesn't contain enough examples, etc. As a developer, I don't want to always have to look at the source code to understand what it does. I want a nice well-presented document (i.e. with a very good user-experience) which explains me the source code.

Also, you should have the documentation for each distribution of ROS.

Note: maybe it would be a clever move to have one or more people who dedicate their time to seriously improve and maintain the documentation!

tfoote commented 6 years ago

All the documentation from that page can be found under the standard "Code API" link which is uniform for all documented packages. And there are versions of that documentation for all rosdistros can be reached within 3 clicks on auto generated standard links as pointed out by

This is an open source project if you'd like to make a contribution that is appreciated. Asserting things are not good enough for you is not productive or helpful, especially if you're assertions are incorrect.

Please read our support guidelines for how to ask questions. I have noticed at least one other instance where your post are combative and inflammatory, these posts are not appropriate and do not follow our guidelines.

nbro commented 6 years ago

All the documentation from that page can be found under the standard "Code API" link which is uniform for all documented packages. And there are versions of that documentation for all rosdistros can be reached within 3 clicks on auto generated standard links as pointed out by

This is an open source project if you'd like to make a contribution that is appreciated. Asserting things are not good enough for you is not productive or helpful, especially if you're assertions are incorrect.

@tfoote Explain to me the upvote of my question and the reason for having multiple answers, then we talk about visibility and incorrectness of my statements.

It's open source, but it is led by people like you and who own the repositories.

I have noticed at least one other instance where your post are combative and inflammatory

I am not going to accept an answer which is not answering to my question. Forget about it!

tfoote commented 6 years ago

I am not going to accept an answer which is not answering to my question. Forget about it!

No one has asked you to accept an answer that does not answer your question. However in that thread two of the most experienced people answering questions (myself and Gijs) have both contributed to and tried to answer. We have both volunteered our time to specifically try to help you answer your question. And we've answered it as best we can based on our undertanding of your question and we've asked for clarifications as to what you consider not answered.

If you want more help on that question you need to take the time and effort to improve your question with clarifications and more details. The better your question the better your answer can be.

@tfoote Explain to me the upvote of my question and the reason for having multiple answers, then we talk about visibility and incorrectness of my statements.

I do not have to explain anything to you. If you are not willing to abide by our guidelines and follow our etiquette our community we will ask you to not participate. Your expectations of what you can ask for/demand from the community members and trying to shame people is not productive and is exactly what I'm talking about. Negative and personal attacks are caustic to the community and are not acceptable. They will discourage contributions and poison the whole community. Please consider this an official warning.

nbro commented 6 years ago

If you are not willing to abide by our guidelines and follow our etiquette our community we will ask you to not participate.

Who said I am not willing to at least read your guidelines? Maybe not in the next days, but maybe one day in the future.

It's you the person who thinks I am attacking others. If a person makes fun of me by answering like "interpolation is interpolation", then do not ask me to react like a stone.

Your expectations of what you can ask for/demand from the community members and trying to shame people is not productive and is exactly what I'm talking about.

My expectations are my expectations, yours are yours.

Negative and personal attacks are caustic to the community and are not acceptable.

I have the freedom of speech and I can share my opinion regarding the irresponsibility of people who share with the world non-optimal products. I have the right to criticize.

Please consider this an official warning.

This looks like a personal attack. Well, it's a point of view, right? Of course, you're right, because you have "power" in this case. Whatever.