blob: a2f7fdb1ef70c9ebb6ed334694738514eabe3291 [file]
# ***************************************************************************************************************************
# * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
# * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
# * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
# * with the License. You may obtain a copy of the License at *
# * *
# * http://www.apache.org/licenses/LICENSE-2.0 *
# * *
# * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
# * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
# * specific language governing permissions and limitations under the License. *
# ***************************************************************************************************************************
# Exceptions to the script-docs checker (scripts/tests/test_script_docs.py).
#
# One pattern per line, relative to scripts/, with a mandatory reason:
# path/glob.sh # why it needs no <name>.md
# flags: tool.py # why its flags cannot be read from the code
# packages: dir1, dir2 # directories that need a README.md instead of per-module docs
#
# tests/, vendor/, node_modules/, __pycache__/ and fixtures/ are skipped without being listed.
# Every script in this directory has its own doc, so nothing is excluded.