Remove separate cpp docs for UnknownExplanation (#7516)
authorGereon Kremer <nafur42@gmail.com>
Thu, 28 Oct 2021 10:07:59 +0000 (03:07 -0700)
committerGitHub <noreply@github.com>
Thu, 28 Oct 2021 10:07:59 +0000 (10:07 +0000)
This removes the separate documentation for the `UnknownExplanation` enum, as it is already included in the documentation of the `Result` class.

docs/api/cpp/cpp.rst
docs/api/cpp/unknownexplanation.rst [deleted file]
docs/api/python/unknownexplanation.rst
src/api/python/cvc5.pxi

index 04f731203e97e70433990ecd6cf6ca8c6ae2cd32..edcbbd87dd3e75ecc7cb7bacb66b1949d3ec66a3 100644 (file)
@@ -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 (file)
index 9a64ec4..0000000
+++ /dev/null
@@ -1,6 +0,0 @@
-UnknownExplanation
-============
-
-.. doxygenenum:: cvc5::api::Result::UnknownExplanation
-    :project: cvc5
-
index 54c37665b8aee6e0f4a4c06099818ebf49586fcb..aee13458288d3b83d92b524412dad6115c75b2b1 100644 (file)
@@ -1,5 +1,5 @@
 UnknownExplanation
-================
+==================
 
 .. autoclass:: pycvc5.UnknownExplanation
     :members:
index 9a7358bbf589b80c3b8697a318bd608398724c37..3367bf47bda69b6b5039e40257967c2b30a418fb 100644 (file)
@@ -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()