search

roboticslab-uc3m / questions-and-answers

A place for general debate and question&answer
https://robots.uc3m.es/developer-manual/appendix/repository-index.html
2 stars 0 forks source link

Plural on tests/examples and other conventions #46

Closed jgvictores closed 6 years ago

jgvictores commented 6 years ago

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:

PeterBowman commented 6 years ago

+1 for plural.

jgvictores commented 6 years ago

+1 for plural.

Yes, I think this is more intuitive.

PeterBowman commented 6 years ago

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

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

PeterBowman commented 6 years ago

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 commented 6 years ago

Updated description with test(s) from #41.

PeterBowman commented 6 years ago

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 commented 6 years ago

(...) 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
PeterBowman commented 6 years ago

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

jgvictores commented 6 years ago

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 commented 6 years ago

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 commented 6 years ago

+1 for a tedious label.

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

PeterBowman commented 6 years ago

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

jgvictores commented 6 years ago

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

Yup!

PeterBowman commented 6 years ago

The following changes have been applied:

Affected and processed repositories:

Affected and ignored repositories:

No more occurrences found.

jgvictores commented 6 years ago

THANKS a lot for all of this!

PeterBowman commented 6 years ago

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).