[Teas] Yangdoctors early review of draft-ietf-teas-yang-te-mpls-03

Carl Moberg via Datatracker <noreply@ietf.org> Wed, 16 September 2020 21:02 UTC

Return-Path: <noreply@ietf.org>
X-Original-To: teas@ietf.org
Delivered-To: teas@ietfa.amsl.com
Received: from ietfa.amsl.com (localhost [IPv6:::1]) by ietfa.amsl.com (Postfix) with ESMTP id AA85D3A10FF; Wed, 16 Sep 2020 14:02:36 -0700 (PDT)
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
From: Carl Moberg via Datatracker <noreply@ietf.org>
To: <yang-doctors@ietf.org>
Cc: teas@ietf.org, draft-ietf-teas-yang-te-mpls.all@ietf.org
X-Test-IDTracker: no
X-IETF-IDTracker: 7.17.0
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <160029015660.12766.12638624588877500672@ietfa.amsl.com>
Reply-To: Carl Moberg <callemoberg@gmail.com>
Date: Wed, 16 Sep 2020 14:02:36 -0700
Archived-At: <https://mailarchive.ietf.org/arch/msg/teas/t_D20hOXhTCBG3aWGTkwzHkAJ-4>
Subject: [Teas] Yangdoctors early review of draft-ietf-teas-yang-te-mpls-03
X-BeenThere: teas@ietf.org
X-Mailman-Version: 2.1.29
List-Id: Traffic Engineering Architecture and Signaling working group discussion list <teas.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/teas>, <mailto:teas-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/teas/>
List-Post: <mailto:teas@ietf.org>
List-Help: <mailto:teas-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/teas>, <mailto:teas-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 16 Sep 2020 21:02:37 -0000

Reviewer: Carl Moberg
Review result: Almost Ready

This is my (belated, apologies) YANG Doctors early review of the ietf-te-mpls
module in draft-ietf-teas-yang-te-mpls-03.

The YANG module extracts and passes validation cleanly, and seems well designed
for its intended purpose. The authors have done a good job. My comments in this
review is focused on suggestions on improving readability and general
uniformity.

I would suggest running the YANG module through the YANG output format of the
pyang tool with the canonical option, i.e.:
 $ pyang -f yang --yang-canonical ietf-te-mpls@2020-03-09.yang

While this will introduce a few spots of whitespace weirdness in the
description fields that will need to be fixed it will generally line up the
formatting consistently across statements, line breaks and other places.

I also believe the description fields could do with some formatting attention.
I am mostly thinking of capitalization and punctuation which varies across.

Apart from that, a few smaller suggestions:

There is a pair of groupings that are used in subsequent groupings for later
reuse. - grouping tunnel-igp-shortcut-config used in grouping
tunnel-igp-shortcuts - grouping tunnel-forwarding-adjacency-configs used in
grouping tunnel-forwarding-adjacency I would suggest using 'config' (singular)
or 'configs' (plural) consistently.

Is there a specific reason to introduce underscores in the identifier string in
the 'tunnel-bandwidth_top' and 'te-path-bandwidth_top' groupings?

There is what seems to be a stray comment on line 413 in the extracted YANG:
  /* MPLS TE interface augmentations */

The next to last augment statement has a description that says "foo".