search

contour-terminal / terminal-good-image-protocol

*Good* Image Protocol - a formalization of a proposal for a new image protocol for virtual terminal emulators
33 stars 2 forks source link

Introduce concepts before describing their behavior #17

Closed db48x closed 3 years ago

db48x commented 3 years ago

It is likely that this isn’t intended, but some concepts are not properly introduced before the spec starts talking about the details of how they behave. For example, section 10.1.1 talks about what the Upload Image command does when the image is named, but this is the first mention that images can be named anywhere in the spec.

christianparpart commented 3 years ago

Oh nice finding.

The spec's two main sections are "Semantics" (s. 10) and "Syntax" (s. 11). Semantics should have introduced everything in order and fully specified except how it looks like on the wire.

"Syntax" (section 11) fills the gap with how it looks like on the wire (actual VT sequences introduced or extended).

Thanks for carefully reading through the draft :)

christianparpart commented 3 years ago

I've just added that as a \subsection into the Semantics section to introduce it all. I hope I did not miss anything. I'll be updating the preview branch soon so that it's also downloadable as PDF (the Github Actions "Summary" page for each action does contain them, too, in case you'd like to read it as PDF earlier).

Many thanks for pointing that out.