Making better use of github ---- all comments in an external file?

Hello Juan

After reading the mail Ken just sent I wonder if we could have all
class comments in an external github file.

In that case we could come up with proposals to  fix them in our forks
and send you pull requests.

You then can pull in the changes and when you prepare an image you
would have to load the class comments file into the image.

What do you think about this idea?

Kind regards
--Hannes

_______________________________________________
Cuis mailing list
[hidden email]
http://jvuletich.org/mailman/listinfo/cuis_jvuletich.org

Hi Hannes,

I think it is a bit redundant with change sets. Why not just create
change sets for class comment updates, or any other updates to Cuis?

Cheers,
Juan Vuletich

H. Hirzel wrote:

_______________________________________________
Cuis mailing list
[hidden email]
http://jvuletich.org/mailman/listinfo/cuis_jvuletich.org

Thank you for your answer, Juan,

Yes, I am aware that it is redundant with change sets. However the
reasons for proposing this are

a) It will not be necessary to create a change set just for comment updates.
b) we can deal with comments on github (e.g. see differences, edit
them etc, have an external printable class documentation)
c) deal with them in one go (i.e. do spell checking)
d) Have a starter file for additional external documentation (-> HTML,
or *.md). See for example the nice Zinc documentation
https://github.com/svenvc/zinc/blob/master/zinc-http-components-paper.md
)

So what we would need are two methods

#writeCommentsToExternalFile:
#loadCommentsFromExternalFile:

However so far we had a lot of changes in the developoment process and
I agree it is better to wait with additional things these upcoming
months. This comment issue is in no way urgent at the moment.

Kind regards

Hannes

On 1/9/13, Juan Vuletich <[hidden email]> wrote:
_______________________________________________
Cuis mailing list
[hidden email]
http://jvuletich.org/mailman/listinfo/cuis_jvuletich.org