From f022da83ea59704c9c7cf0ddb3f73468db1dfdf5 Mon Sep 17 00:00:00 2001 From: Jon Skeet Date: Thu, 19 Nov 2020 15:25:36 +0000 Subject: [PATCH] Delete extraneous markdown files These aren't required for the Standard, and confuse the Word converter Fixes #33. --- standard/cleanup-instructions.md | 90 ---- standard/standard.md | 740 ------------------------------- 2 files changed, 830 deletions(-) delete mode 100644 standard/cleanup-instructions.md delete mode 100644 standard/standard.md diff --git a/standard/cleanup-instructions.md b/standard/cleanup-instructions.md deleted file mode 100644 index 158e0f5bb..000000000 --- a/standard/cleanup-instructions.md +++ /dev/null @@ -1,90 +0,0 @@ -# Instructions for cleaning the standard. - -General instructions: - -1. Target the csharp5-standard branch (in the dotnet/csharplang repo). -1. Each commit should be one header section. -1. Each PR should be an H2 section, no larger. -1. It is essential to have a copy of the standard open in another window. - -## Things to fix - -- There are blank HTML comments that can be removed. These are `<-- -->`. (Yes, but first use them to locate nested bullet lists. See below.) -- Nested bullet lists: See detailed discussion following this list. -- Replace curled quotes with straight quotes (both double quotes and single quotes). -- *Remove non-header anchors.* These look like `[#Grammar_type](type)` -- *Update section references with links.* There are several section references that appear like `(§23.3)`. These should be replaced with links to the appropriate section in markdown. See [standard.md](standard.md) for a mapping of standard section numbers to file and anchor. For example, the preceding example should be `([§23.3](unsafe-code.md#pointer-types))`. Note that these anchors were generated from a single markdown file so it is likely that the numeric extensions will need to be updated. I tried to catch most of these in this PR. Re links to "General" headers, see below. -- Notes have a line like this: `> [!NOTE]`. Those should be replaced with `> *Note*:` and closed with `*end note*`. This preserves the existing block quote style. -- Examples should be block quoted. These should start with `*Example*:` and end with `*end example*`. -- Look carefully for C# keywords that are inline in text. Many of these have been formatted as plain text. -- Some C# keywords are occasionally code fenced when they shouldn't be, because of global search and replace. -- Superscripts don't render correctly and should be replaced with code `^` for exponents. (See below re superscripts.) -- Check code samples for trailing backslash characters -- Tables are incorrectly formatted. These will all need to be reformatted for correct rendering. -- *Optional* The markdown standard for list indentation is 2 spaces. Some areas of source have 4 spaces. 2 is preferred. (See below.) -- Em-dash and en-dash appear to get converted to en-dash, which in some cases looks odd when rendered. -- Links to "General" headers. (See below.) - -## Nested bullet lists - -Rex stumbled on this in Clause 11, "Conversions", which has lists nested to 2 and 3 levels. **The Word-to-md conversion flattens all nested lists to 1 level!** Consider the following in which we have 3 levels, with zzz subordinate to yyy, which in turn is subordinate to xxx. The md that resulted was, as follows: -``` -- xxx - -- yyy - -- zzz - -``` -Specifically, the intro dash for the subordinate list entries is *not indented* but it needs to be (2 and 4 spaces, respectively)! The converter puts the HTML comment "\