faiss/tests/test_doxygen_documentation.py
Lucas Hosseini 79e74fe307 Generate python docstrings from doxygen comments. (#1969)
Summary: Pull Request resolved: https://github.com/facebookresearch/faiss/pull/1969

Reviewed By: mdouze

Differential Revision: D31084784

Pulled By: beauby

fbshipit-source-id: 32b152f10fde9a0f5299909b8fd5c855fe738996
2021-10-10 22:14:48 -07:00

18 lines
473 B
Python

# Copyright (c) Facebook, Inc. and its affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
import unittest
import faiss
class TestDocumentation(unittest.TestCase):
def test_doxygen_comments(self):
maxheap_array = faiss.float_maxheap_array_t()
self.assertTrue("a template structure for a set of [min|max]-heaps"
in maxheap_array.__doc__)