search

jeanluct / braidlab

Matlab package for analyzing data using braids
GNU General Public License v3.0
23 stars 9 forks source link

Document C++ version of colorbraiding in the user's manual #63

Closed jeanluct closed 9 years ago

jeanluct commented 9 years ago

From Jean-Luc Thiffeault on 2014-09-24 18:18:22+00:00

In what sense? I'm not sure there is much to document. The option to switch to the Matlab version is an advanced feature. My thinking is that we should leave such things out of the basic manual until later (much later).

But if there's something you think could trip up a typical user, I'd like to hear about it.

jeanluct commented 9 years ago

From Marko Budisic on 2014-09-24 21:07:36+00:00

I was just splitting two things you asked me to do in your first (recent) comment on colobraiding_helper Issue #55: one had to do with enabling C++ code by default, the other with documenting something. I wanted to actually talk to you about this, as I didn't know what would need to be documented. Feel free to close if this is a non-issue.

jeanluct commented 9 years ago

From Jean-Luc Thiffeault on 2014-09-24 22:01:48+00:00

Ok, I thought there might have been something to document but your comments in the file itself are probably ok for now.