Additional help for preamble-eip

ethereum · Feb 14, 2023 · f14f325 · f14f325
1 parent 6d4b2e5
commit f14f325
Showing 1 changed file with 47 additions and 0 deletions.
diff --git a/docs/preamble-eip/index.html b/docs/preamble-eip/index.html
@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8">
+		<title>preamble-eip</title>
+		<link rel="stylesheet" href="../main.css">
+		<meta name="viewport" content="width=device-width, initial-scale=1">
+	</head>
+	<body>
+		<article>
+			<h1><code>preamble-eip</code></h1>
+			<p>
+				The <code>eip</code> header is a non-negative integer.
+			</p>
+
+			<section>
+				<h2>Examples</h2>
+
+				<pre>error[preamble-eip]: preamble header `eip` must be an unsigned integer
+ --> input.md:2:5
+  |
+2 | eip: 1abc
+  |     ^^^^^ not a non-negative integer
+  |</pre>
+			</section>
+			<section>
+				<h2>Explanation</h2>
+
+				<p>
+					<code>preamble-eip</code> makes sure the <code>eip</code>
+					front matter (or preamble) field is a non-negative integer.
+				</p>
+
+				<p>
+					Each proposal is identified with a number. The
+					<code>eip</code> field holds that number.
+				</p>
+
+				<p>
+					Before an EIP Editor assigns a number, it is acceptable to
+					leave this field as <code>eip: &lt;to be assigned&gt;</code>
+					or omit it entirely.
+				</p>
+			</section>
+		</article>
+	</body>
+</html>