kubernetes / kubectl

Issue tracker and mirror of kubectl code
Apache License 2.0
2.82k stars 909 forks source link

`kubectl explain` not re-wrapping lines #1623

Open dhaiducek opened 1 month ago

dhaiducek commented 1 month ago

What happened:

A description like this block that wraps at 100 characters:

 // Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus pulvinar in libero id sagittis.
 // Aliquam sem enim, vehicula et urna ac, vehicula ullamcorper sem. Morbi turpis arcu, aliquet at 
 // eros quis, sodales dignissim eros. Quisque ut lectus quis magna maximus elementum a nec felis. 
 // Nulla ultricies pulvinar quam, id tincidunt. 

Appears like this in kubectl explain, with weird line breaks:

key <type>
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus pulvinar in
  libero id sagittis.
  Aliquam sem enim, vehicula et urna ac, vehicula ullamcorper sem. Morbi turpis 
  arcu, aliquet at 
  eros quis, sodales dignissim eros. Quisque ut lectus quis magna maximus 
  elementum a nec felis. 
  Nulla ultricies pulvinar quam, id tincidunt.

What you expected to happen:

OpenAPIv3 is formatted as Markdown, so I'd expect kubectl explain to reflow each description to realign line breaks, according to the rules of Markdown (i.e. respecting lists and the like):

key <type>
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus pulvinar in
  libero id sagittis. Aliquam sem enim, vehicula et urna ac, vehicula 
  ullamcorper sem. Morbi turpis arcu, aliquet at eros quis, sodales dignissim 
  eros. Quisque ut lectus quis magna maximus elementum a nec felis. Nulla 
  ultricies pulvinar quam, id tincidunt.

How to reproduce it (as minimally and precisely as possible):

Anything else we need to know?:

Environment:

mpuckett159 commented 1 month ago

/triage accepted /kind feature

ah8ad3 commented 1 month ago

Thanks for raising this, @dhaiducek kubectl explain already has that wrap mechanism, but it may be acting wired in some scenarios. I will take a look at this. /assign