Plural on tests/examples and other conventions

[jgvictores]

Singular or plural and other conventions:

1. Derived from the constant example (yarp-ish) vs examples directory.
2. @PeterBowman pointed out this also happens with cmake/template vs cmake/templates
3. Also test(s)

Proposed ToDo:

• Decide on standard.
• Update https://github.com/roboticslab-uc3m/project-generator (which BTW has no examples).
• Reflect standard in https://github.com/roboticslab-uc3m/developer-manual.
• Mention said standard in https://github.com/roboticslab-uc3m/project-generator (README.md)
• Look for occurrences across remaining org repos and update accordingly.

[PeterBowman]

+1 for plural.

[jgvictores]

+1 for plural.

Yes, I think this is more intuitive.

[PeterBowman]

Also, I started cleaning a bit the contents of cmake/, thus we may encounter subdirs such as:

• cmake/find-modules/ (FindPkg.cmake and similar)
• cmake/modules/ (general CMake utilities)

In the future, YCM build modules could be moved into cmake/build-modules/. I borrowed this idea from the YCM repo.

[PeterBowman]

In the future, YCM build modules could be moved into cmake/build-modules/. I borrowed this idea from the YCM repo.

I'd suggest another name since .gitignore will probably mess up with anything that starts with build (proof). Perhaps... cmake/ycm-modules/, and also move IncludeUrl.cmake and YCMBootstrap.cmake in there.

[jgvictores]

Updated description with test(s) from #41.

[PeterBowman]

Decide on standard.

Perhaps we could go a bit further and outline the standard directory layout for most projects, that is, the tree structure of folders (libraries/, programs/, test()s/, etc.). Yeah, this is somehow reflected in project-generator, but might be best doing it in a more official way with a mention in developer-manual.

[jgvictores]

(...) might be best doing it in a more official way with a mention in developer-manual.

LGTM! Some comments:

1. Yes, I like the idea of a reference guide in developer-manual; hence, project-generator as an implementation that points to it.
2. Take into account https://github.com/roboticslab-uc3m/project-generator/issues
   • We should take Coexistence with ROS folder structure? project-generator#18 (Coexistence with ROS folder structure) into account.
   • We would be answering to Document the usage of the generated structure project-generator#17

[PeterBowman]

Also: doc -> docs? I don't want to get too far...

[jgvictores]

Not sure... I've always read doc as documentation rather than documents.
Perhaps laziness, as there is a considerable amount of links that would have to be updated across organizations.

[PeterBowman]

Not sure about what feels better, see https://readthedocs.org/. I'd succumb to laziness for this one, though.

there is a considerable amount of links that would have to be updated across organizations.

I was about to prepare a TODO list, but there are so many repos with cmake/template/... +1 for a tedious label.

[jgvictores]

+1 for a tedious label.

Totally agreed: Ref ((in Spanish, color is meaningful too))

[PeterBowman]

Reminder: also apply plural rules in Doxyfile! >>REF<<

[jgvictores]

Reminder: also apply plural rules in Doxyfile! >>REF<<

Yup!

[PeterBowman]

The following changes have been applied:

• rename example/ to examples/
• rename test/ to tests/
• rename cmake/template/ to cmake/templates/
• update doc/Doxyfile

Affected and processed repositories:

• kinematics-dynamics
• yarp-devices
• openrave-yarp-plugins
• speech
• vision
• tools
• developer-manual
• installation-guides
• teo-main
• teo-developer-manual
• teo-configuration-files
• teo-openrave-models
• asibot-hmi
• asibot-configuration-files
• asibot-openrave-models
• amor-configuration-files
• amor-openrave-models
• tiago-main
• color-debug
• project-generator
• xgnitive

Affected and ignored repositories:

• follow-me
• footsteps
• force-torque-balance
• fpga-nn
• fusion-control
• gait
• gaitcontrol
• legacy-matlab-visual-servo
• manip-waiter
• teo-bimanipulation
• teo-grasp
• teo-self-presentation
• waiter

No more occurrences found.

[jgvictores]

THANKS a lot for all of this!

[PeterBowman]

Also: doc -> docs? I don't want to get too far...

Not sure... I've always read doc as documentation rather than documents.
Perhaps laziness, as there is a considerable amount of links that would have to be updated across organizations.

Just noticed that YCM has a docs directory (ref).