Comments (13)
From @fabienrohrer on January 19, 2016 8:36
About fields, the reference manual follows more or less this rule:
NodeName {
VRMLType fieldName defaultValues # [\[\(]minRange,maxRange[\]\)], (units)
}
All of the case can be seen here:
https://www.cyberbotics.com/reference/contactproperties.php
➡️ I would propose to homogenize this.
Some of them are showing a small label explaining the field:
https://www.cyberbotics.com/reference/accelerometer.php
But this seems redundant with the description bellow.
➡️ I would propose to drop this description label.
This is redundant also with the comments here:
https://github.com/omichel/webots/blob/master/resources/nodes/
About function units, it is generally described in the comments.
For example, the return of the [m/s^2] of the Accelerometer's wb_accelerometer_get_values() function.
➡️ I would propose to describe the units of the function into the function description.
from webots-doc.
From @fabienrohrer on January 19, 2016 8:37
If everyone agree, I can begin this refactoring.
from webots-doc.
From @omichel on January 19, 2016 8:45
I wouldn't drop the comments from the *.wrl files as they are useful when you look at these files to understand the nodes without having to go to the reference manual.
from webots-doc.
From @omichel on January 19, 2016 8:49
Maybe you address a single node for now and post the results here for review, so that we can agree if this is the right way to do.
from webots-doc.
From @fabienrohrer on January 19, 2016 8:52
I wouldn't drop the comments from the *.wrl files as they are useful when you look at these files to understand the nodes without having to go to the reference manual.
Maintaining duplicate data should be avoided in every case. The proof of this is that this directory is currently completely unsynchronized from the reference manual.
The users are not interesting in seeing this directory.
The argument about our convenience seems weak against the data duplication in my point of view.
Maybe you address a single node for now and post the results here for review, so that we can agree if this is the right way to do.
Good idea. I will try to find a node with all the issues.
from webots-doc.
From @stefaniapedrazzi on January 19, 2016 8:59
Personally I think it is very useful for us to have comments in the WRL files and we should keep them.
Then, I'm not sure to understand where you want to add the units description in the reference manual but I like the form:
NodeName {
VRMLType fieldName defaultValues # [\[\(]minRange,maxRange[\]\)], (units)
}
as it is immediately visible without having to search into the text.
from webots-doc.
From @fabienrohrer on January 19, 2016 9:21
I'm strictly convinced that duplicating data should be avoided in this case.
https://en.wikipedia.org/wiki/Don%27t_repeat_yourself
from webots-doc.
From @stefaniapedrazzi on January 19, 2016 9:27
Where do you mean we are duplicating the data?
from webots-doc.
From @fabienrohrer on January 19, 2016 9:30
The comments of the nodes description in the reference manual, and the comments in the *wrl files. They are currently half copy-pasted.
from webots-doc.
From @stefaniapedrazzi on January 19, 2016 9:41
It seems that in the reference manual we only show the range and the units and not the other comments.
Personally I'm not sure if I would consider this as documentation of the field or duplication of the code in WRL.
from webots-doc.
Fixed #600
from webots-doc.
Range documentation have been solved in https://github.com/omichel/webots-doc/pull/600/files but units are still under-documented. A user just reported this again.
from webots-doc.
I will fix the issues reported by this user: missing units for wb_motor_set/get_available_force()
and LinearMotor.maxForce
and I will check other similar units with RotationalMotor
and torque.
from webots-doc.
Related Issues (20)
- Robot compenent: right menu size doesn't adapt to long device names
- Improvements of the tab component HOT 1
- Text cut vertically in charts HOT 1
- Wrong highlighting of MATLAB section title HOT 2
- Node enumeration lists are not up-to-date HOT 3
- Blog Post for Webots R2018b HOT 2
- Update Display node with PBR HOT 1
- Display with Attached Camera Should Disable Filtering
- Document camera object recognition label when mouse is over the overlay
- Wrong paths to Automobile libraries in the Using Visual C++ with Webots page HOT 1
- Update nodes-and-keywords.md page HOT 1
- Texture image naming convention
- Replace 'Main Toolbar' decsription by 'Context Menu' description HOT 1
- Improve Project Hierarchy Description
- Robot component: scene IDs improvement HOT 1
- OSM Importer Dependencies Installation are Python2 Specific HOT 1
- Simple Mechanical Loop Sample
- Document SmartScreen trusts installers for windows installation HOT 1
- Bad Google referencing for the doc HOT 20
- Wrong URL
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from webots-doc.