github.com/alex123012/deckhouse-controller-tools@v0.0.0-20230510090815-d594daf1af8c/pkg/genall/help/pretty/doc.go (about)

     1  /*
     2  Copyright 2019 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  // Package pretty contains utilities for formatting terminal help output,
    18  // and a use of those to display marker help.
    19  //
    20  // # Terminal Output
    21  //
    22  // The Span interface and Table struct allow you to construct tables with
    23  // colored formatting, without causing ANSI formatting characters to mess up width
    24  // calculations.
    25  //
    26  // # Marker Help
    27  //
    28  // The MarkersSummary prints a summary table for marker help, while the MarkersDetails
    29  // prints out more detailed information, with explainations of the individual marker fields.
    30  package pretty