johnnydecimal / index-spec

A 'formal' specification for the index file. And any other data structures.
MIT License
20 stars 0 forks source link

Comment Association #1

Open donovanglover opened 10 months ago

donovanglover commented 10 months ago

Should comments be associated with Areas/Categories/IDs? Seems like it'd be easier to recreate the index with comments if e.g. comments had to be below (or beside) the item they refer to. Could also show the comments in UIs for JD?

Comments below makes it easier to have a comment at the top that's like a description of the project.

johnnydecimal commented 10 months ago

Yeah, the idea was that any AC.ID can have a comment.

And they might be represented a few ways:

10-19 My area // inline
10-19 My area
/* This comment is associated with
   the item immediately above it. */
10-19 My area
      - Comment: I guess we could also do comments like this?

Of those, the /* multi-line */ feels the most difficult and would be the one I would be happy to abandon at this point.

Happy to hear alternatives!