From 0c7fcf636b9f444f5b21bfce50fecf01aad819f6 Mon Sep 17 00:00:00 2001 From: Daira Hopwood Date: Tue, 3 Sep 2019 14:19:44 +0100 Subject: [PATCH] zip-guide.rst: clarify that an Abstract should not contain specification. Signed-off-by: Daira Hopwood --- zip-guide.html | 5 +++-- zip-guide.rst | 7 +++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/zip-guide.html b/zip-guide.html index 3751c80a..4d4eaea2 100644 --- a/zip-guide.html +++ b/zip-guide.html @@ -34,8 +34,9 @@ License: {usually MIT}

Abstract

-

{Describe what this proposal does, typically in a few paragraphs.}

-

{Use links where applicable, e.g. 2.}

+

{Describe what this proposal does, typically in a few paragraphs.

+

The Abstract should only provide a summary of the ZIP; the ZIP should remain complete without the Abstract.

+

Use links where applicable, e.g. 2.}

Motivation

diff --git a/zip-guide.rst b/zip-guide.rst index 4a936df1..9fe94f56 100644 --- a/zip-guide.rst +++ b/zip-guide.rst @@ -42,9 +42,12 @@ The terms below are to be interpreted as follows: Abstract ======== -{Describe what this proposal does, typically in a few paragraphs.} +{Describe what this proposal does, typically in a few paragraphs. -{Use links where applicable, e.g. [#protocol]_.} +The Abstract should only provide a summary of the ZIP; the ZIP should remain +complete without the Abstract. + +Use links where applicable, e.g. [#protocol]_.} Motivation