github.com/opcr-io/oras-go/v2@v2.0.0-20231122155130-eb4260d8a0ae/registry/internal/doc/doc.go (about)

     1  /*
     2  Copyright The ORAS Authors.
     3  Licensed under the Apache License, Version 2.0 (the "License");
     4  you may not use this file except in compliance with the License.
     5  You may obtain a copy of the License at
     6  
     7  http://www.apache.org/licenses/LICENSE-2.0
     8  
     9  Unless required by applicable law or agreed to in writing, software
    10  distributed under the License is distributed on an "AS IS" BASIS,
    11  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  See the License for the specific language governing permissions and
    13  limitations under the License.
    14  */
    15  
    16  // Package doc provides the constant can be used in example test files. Most of
    17  // the example tests in this repo are fail to run on the GoDoc website because
    18  // of the missing variables. In order to avoid confusing users, these tests
    19  // should be unplayable on the GoDoc website, and this can be achieved by
    20  // leveraging a dot import in the test files.
    21  // Reference: https://pkg.go.dev/go/doc#Example
    22  package doc
    23  
    24  // ExampleUnplayable is used in examples test files in order to make example
    25  // tests unplayable.
    26  const ExampleUnplayable = true