search

haomianzheng / IETF-ACTN-YANG-Model

IETF Optical YANG models in ACTN Architecture
4 stars 4 forks source link

Rtgdir early review comments #134

Closed italobusi closed 7 months ago

italobusi commented 1 year ago

Summary:

I found the document rather difficult to read. While I had just read layer1-types, and there is a nice Figure 1, then I saw section 3, and my eyes blurred.

Comments:

I don't think that the YANG Tree display adds anything to the document as is. Maybe if it had a softer walk-through like in layer1-types it would be more useful.

I read the YANG, and it's among the most complex I have ever read.

I didn't know augment took +, and there are too many dependancies for me to understand trivially what any of this code is doing. That doesn't mean it's wrong, rather than it's unlikely that anyone who is not very very deeply steeped in this content will be able to make any determination as to whether it's correct.

Nits:

None that I saw.

See: https://mailarchive.ietf.org/arch/msg/ccamp/rUOJW7FlTsYZ5E9jC0qDt89IsQE/

italobusi commented 1 year ago

Agreed that there is anything specific that could be done to improve the document's readability: only someone that is deeply involved in the subject (in particular with RFC8795) can read the YANG code

italobusi commented 1 year ago
italobusi commented 7 months ago
  • [x] @italobusi : reply to the Rtgdir review mail

See: https://mailarchive.ietf.org/arch/msg/ccamp/wJLBwqBdgoojUJ3_LJMXNQfsRGk/