feat(term): xpty: add godocs

exp/term/xpty/conpty.go

@@ -34,7 +34,7 @@ func (c *ConPty) Name() string {
 }
 
 // Start starts a command on the ConPty.
+// This is a wrapper around conpty.Spawn.
 func (c *ConPty) Start(cmd *exec.Cmd) error {
 	return c.start(cmd)
 }
-

exp/term/xpty/xpty.go

@@ -46,6 +46,23 @@ type Options struct {
 type PtyOption func(o Options)
 
 // NewPty creates a new PTY.
+//
+// The returned PTY will be a Unix PTY on Unix systems and a ConPTY on Windows.
+// The width and height parameters specify the initial size of the PTY.
+// You can pass additional options to the PTY by passing PtyOptions.
+//
+//	pty, err := xpty.NewPty(80, 24)
+//	if err != nil {
+//	   // handle error
+//	}
+//
+//	defer pty.Close() // Make sure to close the PTY when done.
+//	switch pty := pty.(type) {
+//	case xpty.UnixPty:
+//	    // Unix PTY
+//	case xpty.ConPty:
+//	    // ConPTY
+//	}
 func NewPty(width, height int, opts ...PtyOption) (Pty, error) {
 	if runtime.GOOS == "windows" {
 		return NewConPty(width, height, opts...)