summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGereon Kremer <nafur42@gmail.com>2021-10-28 03:07:59 -0700
committerGitHub <noreply@github.com>2021-10-28 10:07:59 +0000
commit46f5a39730ebd42421963c23de81a75652fb6629 (patch)
tree8d69d563d7fb8f024b794fa5dc456080760c4bf9
parentc30a8af3a0aeca118deb0491044cfa0678da3b94 (diff)
Remove separate cpp docs for UnknownExplanation (#7516)
This removes the separate documentation for the `UnknownExplanation` enum, as it is already included in the documentation of the `Result` class.
-rw-r--r--docs/api/cpp/cpp.rst3
-rw-r--r--docs/api/cpp/unknownexplanation.rst6
-rw-r--r--docs/api/python/unknownexplanation.rst2
-rw-r--r--src/api/python/cvc5.pxi4
4 files changed, 3 insertions, 12 deletions
diff --git a/docs/api/cpp/cpp.rst b/docs/api/cpp/cpp.rst
index 04f731203..edcbbd87d 100644
--- a/docs/api/cpp/cpp.rst
+++ b/docs/api/cpp/cpp.rst
@@ -30,6 +30,3 @@ C++ API Documentation
sort
statistics
term
- unknownexplanation
-
-
diff --git a/docs/api/cpp/unknownexplanation.rst b/docs/api/cpp/unknownexplanation.rst
deleted file mode 100644
index 9a64ec4aa..000000000
--- a/docs/api/cpp/unknownexplanation.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-UnknownExplanation
-============
-
-.. doxygenenum:: cvc5::api::Result::UnknownExplanation
- :project: cvc5
-
diff --git a/docs/api/python/unknownexplanation.rst b/docs/api/python/unknownexplanation.rst
index 54c37665b..aee134582 100644
--- a/docs/api/python/unknownexplanation.rst
+++ b/docs/api/python/unknownexplanation.rst
@@ -1,5 +1,5 @@
UnknownExplanation
-================
+==================
.. autoclass:: pycvc5.UnknownExplanation
:members:
diff --git a/src/api/python/cvc5.pxi b/src/api/python/cvc5.pxi
index 9a7358bbf..3367bf47b 100644
--- a/src/api/python/cvc5.pxi
+++ b/src/api/python/cvc5.pxi
@@ -569,8 +569,8 @@ cdef class Result:
def isNull(self):
"""
- :return: True if Result is empty, i.e., a nullary Result,
- and not an actual result returned from a :cpp:func:`Solver::checkSat() <cvc5::api::Solver::checkSat>` (and friends) query.
+ :return: True if Result is empty, i.e., a nullary Result, and not an actual result returned from a
+ :cpp:func:`Solver::checkSat() <cvc5::api::Solver::checkSat>` (and friends) query.
"""
return self.cr.isNull()
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback