Re: [Tools-discuss] markdown .md file tools

Carsten Bormann <cabo@tzi.org> Fri, 29 April 2022 19:41 UTC

Return-Path: <cabo@tzi.org>
X-Original-To: tools-discuss@ietfa.amsl.com
Delivered-To: tools-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id A9C2AC14F74B for <tools-discuss@ietfa.amsl.com>; Fri, 29 Apr 2022 12:41:41 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.9
X-Spam-Level:
X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id DaOnw_PJgIhS for <tools-discuss@ietfa.amsl.com>; Fri, 29 Apr 2022 12:41:40 -0700 (PDT)
Received: from gabriel-smtp.zfn.uni-bremen.de (gabriel-smtp.zfn.uni-bremen.de [IPv6:2001:638:708:32::15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id CEC28C14F726 for <tools-discuss@ietf.org>; Fri, 29 Apr 2022 12:41:38 -0700 (PDT)
Received: from smtpclient.apple (p5089ad4f.dip0.t-ipconnect.de [80.137.173.79]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by gabriel-smtp.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4KqjXt0s8rzDCbG; Fri, 29 Apr 2022 21:41:34 +0200 (CEST)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3696.80.82.1.1\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <CAC8QAccvbbbDk6OJnFUxoco9W0SoQ2B9Pj5gwmsWgBTeQv38xw@mail.gmail.com>
Date: Fri, 29 Apr 2022 21:41:33 +0200
Cc: "Andrew G. Malis" <agmalis@gmail.com>, tools-discuss <tools-discuss@ietf.org>
Content-Transfer-Encoding: quoted-printable
Message-Id: <54369A71-C3E7-4968-B284-36D8E374937E@tzi.org>
References: <CAC8QAcejNqxqaO7jsW=DuVnUEF0ohQ6CJUFxWe5Oxw_m_TC4Sw@mail.gmail.com> <CAA=duU2bgc10NL8HC=iQxNh48_yE19hxqNrVjQzk1BumsOxDMw@mail.gmail.com> <CAC8QAccvbbbDk6OJnFUxoco9W0SoQ2B9Pj5gwmsWgBTeQv38xw@mail.gmail.com>
To: sarikaya@ieee.org
X-Mailer: Apple Mail (2.3696.80.82.1.1)
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/QeS1FnKKnOovw1_2fqu40fB8CWo>
Subject: Re: [Tools-discuss] markdown .md file tools
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.34
Precedence: list
List-Id: IETF Tools Discussion <tools-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-discuss/>
List-Post: <mailto:tools-discuss@ietf.org>
List-Help: <mailto:tools-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 29 Apr 2022 19:41:41 -0000

On 29. Apr 2022, at 21:25, Behcet Sarikaya <sarikaya2012@gmail.com> wrote:
> 
> I think that kramdown tool that I was using gives error messages that are tricky, it does not point exactly to where the problem is, you need to find it yourself

Hi Behcet,

I’m sorry, but I can’t let that stand.

Of course, any piece of software sometimes produces error messages that don’t tell you exactly where to fix the input and how.
If software could do that, there would be no need for error messages — the software could just fix the input itself.

The two messages you got were:

>> *** Input contains HT ("tab") characters. Undefined behavior will ensue.
> 
> This is a warning. How to fix this depends on your platform and/or editor of choice.
> 
>> /System/Library/Frameworks/Ruby.framework/Versions/2.6/usr/lib/ruby/2.6.0/psych.rb:456:in `parse': (<unknown>): did not find expected key while parsing a block mapping at line 36 column 3 (Psych::SyntaxError)
> 
> Something is wrong with your YAML header at line 36, column 3.

OK, the first message is opaque.  It is just a reminder that in this century, we shouldn’t be using HT characters in text input because desasters happen like RFC 7386/7396 (an RFC needed to be reissued because HT characters were introduced in editing and led to incorrect pseudocode).  The message is not more specific because people who have one HT character in their input often have many and are better off with expanding tabs in the favorite editor before trying again.

The second message *cannot* be more specific as to where the problem is.  Line 36, column 3.

Grüße, Carsten