This repository has been archived by the owner on Jul 30, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 544
ASCII art in source files is not helpful #1201
Comments
chaals
added a commit
that referenced
this issue
Feb 9, 2018
Remove the ASCII-art version of the filename, and add useful information about the chapter See also #1201
what to do ?? |
I filed one PR that covers the introduction chapter - #1202 I am trying to get another one through my temporarily blocked up machine, covering the other items I ticked off the list. Anyone should feel free to tick something off and file a PR to cover it... |
chaals
pushed a commit
that referenced
this issue
Feb 10, 2018
"drive-by" work for #1201 since I am editing this page
@chaals I was going to try to take care of a few of these over the weekend. Would you rather I piggy back off your existing PR, or create a PR of my own changes? Thanks |
Easier if you make your own I think, although I am not that fussed. I started ticking off items as I was about to do them, which might help. |
chaals
pushed a commit
that referenced
this issue
Feb 10, 2018
Various improvements toward #1201 * Add source header for sections * Index of Attributes source header * Index of Elements source header * Index of Element Content Categories source header * Index of Events source header * Index of Element Interfaces source header * formatting consistency of Index tables
chaals
added a commit
that referenced
this issue
Feb 13, 2018
chaals
added a commit
that referenced
this issue
Feb 13, 2018
scottaohara
pushed a commit
that referenced
this issue
Feb 13, 2018
chaals
added a commit
that referenced
this issue
Feb 15, 2018
Remove the ASCII-art version of the filename, and add useful information about the chapter See also #1201
scottaohara
pushed a commit
that referenced
this issue
Feb 15, 2018
* Update comments in some source files This covers some of list in #1201 * fix typo in dom.include
Merged
chaals
added a commit
that referenced
this issue
Feb 17, 2018
* Update header comment in "embedded content" See also #1201
scottaohara
pushed a commit
that referenced
this issue
Feb 17, 2018
* Update header comment in "embedded content" See also #1201
chaals
pushed a commit
that referenced
this issue
Feb 18, 2018
* link source header comments * IANA source header comments * XML source header comments * make formatting consistent These changes are for #1201
chaals
pushed a commit
that referenced
this issue
Feb 19, 2018
scottaohara
added a commit
that referenced
this issue
Feb 19, 2018
* link source header comments * IANA source header comments * XML source header comments * make formatting consistent These changes are for #1201
scottaohara
added a commit
that referenced
this issue
Feb 19, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
The source files generally start with a giant ASCII art version of the name, in a comment.
It is not always legible, and in any event it doesn't provide much in the way of value. It would be more helpful to describe the source file, what it contains, and where it ends up in the spec, for example
The text was updated successfully, but these errors were encountered: