From c10b7cd820874995a1a840c2f6345338e2b6f745 Mon Sep 17 00:00:00 2001 From: Ong Yong Xin Date: Fri, 3 Nov 2023 17:12:39 +0800 Subject: [PATCH] Add doc.go descriptions to packages --- pkg/asset/doc.go | 2 ++ pkg/document/doc.go | 2 ++ pkg/source/doc.go | 2 ++ pkg/sse/doc.go | 5 +++++ 4 files changed, 11 insertions(+) create mode 100644 pkg/asset/doc.go create mode 100644 pkg/document/doc.go create mode 100644 pkg/source/doc.go create mode 100644 pkg/sse/doc.go diff --git a/pkg/asset/doc.go b/pkg/asset/doc.go new file mode 100644 index 0000000..b328b60 --- /dev/null +++ b/pkg/asset/doc.go @@ -0,0 +1,2 @@ +// Package asset provides an embedded filesystem that serves client-side CSS and JS. +package asset \ No newline at end of file diff --git a/pkg/document/doc.go b/pkg/document/doc.go new file mode 100644 index 0000000..6fdff17 --- /dev/null +++ b/pkg/document/doc.go @@ -0,0 +1,2 @@ +// Package document implements Markdown document processing and serving. +package document diff --git a/pkg/source/doc.go b/pkg/source/doc.go new file mode 100644 index 0000000..8f47161 --- /dev/null +++ b/pkg/source/doc.go @@ -0,0 +1,2 @@ +// Package source contains various file sources for Markdown documents. +package source diff --git a/pkg/sse/doc.go b/pkg/sse/doc.go new file mode 100644 index 0000000..4897d0a --- /dev/null +++ b/pkg/sse/doc.go @@ -0,0 +1,5 @@ +// Package sse implements server-sent events as described by the HTML Standard. +// See https://html.spec.whatwg.org/multipage/server-sent-events.html for more details. +// +// Currently, only a server implementation is provided. +package sse