Spaces:
Paused
Paused
# Copyright 2024 The HuggingFace Team. All rights reserved. | |
# | |
# Licensed 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. | |
""" | |
Doc utilities: Utilities related to documentation | |
""" | |
import re | |
def replace_example_docstring(example_docstring): | |
def docstring_decorator(fn): | |
func_doc = fn.__doc__ | |
lines = func_doc.split("\n") | |
i = 0 | |
while i < len(lines) and re.search(r"^\s*Examples?:\s*$", lines[i]) is None: | |
i += 1 | |
if i < len(lines): | |
lines[i] = example_docstring | |
func_doc = "\n".join(lines) | |
else: | |
raise ValueError( | |
f"The function {fn} should have an empty 'Examples:' in its docstring as placeholder, " | |
f"current docstring is:\n{func_doc}" | |
) | |
fn.__doc__ = func_doc | |
return fn | |
return docstring_decorator | |