search

robotology / whole-body-estimators

YARP devices that implement estimators for humanoid robots.
26 stars 12 forks source link

Document the added variables to use the temperature coefficients #50

Closed fjandrad closed 3 years ago

fjandrad commented 4 years ago

The PR https://github.com/robotology/whole-body-estimators/pull/45 adds the options to use temperature coefficients and offline estimated offset. We will detail the usage of this functions in the wiki in this repo.

fjandrad commented 4 years ago

Documentation has been added in this wiki Feel free to check and signal if something is not clear. @prashanthr05 @traversaro @S-Dafarra

traversaro commented 4 years ago

I strongly suggest not to use the wiki for this kind of documentation, but rather make sure that the docs are stored in the repo, eventually as a .md file containing exactly the same content of the wiki page, but inside of the repo. The rationale behind that is that so you always know which version of the software the documentation refers to. For example, let's say that in the future I want to add a new parameters, and I add the software in the devel branch, and it gets merged in master only after six months. When I should update the docs, if they are stored in the wiki? If I update it before master have changed, people using the master branch may be confused. All this problems are avoided if the docs are put inside the repo.

fjandrad commented 4 years ago

Pending to move the wiki to a docs folder

prashanthr05 commented 4 years ago

Pending to move the wiki to a docs folder

I have done this in https://github.com/robotology/whole-body-estimators/pull/84

HosameldinMohamed commented 3 years ago

PR #84 is merged with devel

I close this issue.