From a10a7b24f45ff7632ebd49a754ba294457432a03 Mon Sep 17 00:00:00 2001 From: Ray Zimmerman Date: Tue, 12 Mar 2024 15:57:33 -0600 Subject: [PATCH] Minor updates to Sphinx documentation. - Use MP-Test rather than |MPTEST| because it really gains us nothing. --- docs/sphinx/source/index.rst | 18 +++++++++--------- docs/sphinx/source/reference.rst | 8 ++++---- lib/mptestver.m | 2 +- lib/t/t_have_feature.m | 1 + lib/t/t_test_fcns.m | 1 + 5 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 5bb8f42..0800fc1 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -1,11 +1,11 @@ -###################### -|MPTEST| User's Manual -###################### +##################### +MP-Test User's Manual +##################### .. .. note:: - The new web-based version of the |MPTEST| User's Manual is not yet available. Please, continue to use the |MPTESTman| on GitHub for now. + The new web-based version of the MP-Test User's Manual is not yet available. Please, continue to use the |MPTESTman| on GitHub for now. |MPTEST>| is a set of functions for implementing unit testing in |MATLAB>| or |Octave>|. It was initially developed for |MATPOWER>|, and is used by @@ -23,11 +23,11 @@ can skip directly to step 3 to verify.* Installation and use of |MPTEST>| requires familiarity with the basic operation of MATLAB or Octave, including setting up your MATLAB/Octave path. -1. Clone the repository or download and extract the zip file of the |MPTEST| +1. Clone the repository or download and extract the zip file of the MP-Test distribution from the |MPTEST>| `project page `_ to the location of your choice. The files in the resulting ``mptest`` or ``mptestXXX`` directory, - where ``XXX`` depends on the version of |MPTEST|, should not need to be + where ``XXX`` depends on the version of MP-Test, should not need to be modified, so it is recommended that they be kept separate from your own code. We will use :samp:`{}` to denote the path to this directory. @@ -38,7 +38,7 @@ of MATLAB or Octave, including setting up your MATLAB/Octave path. - :samp:`{}/lib/t` 3. At the |MATLAB|/Octave prompt, type ``test_mptest`` to run the test suite - and verify that |MPTEST| is properly installed and functioning. The result + and verify that MP-Test is properly installed and functioning. The result should resemble the following:: >> test_mptest @@ -110,7 +110,7 @@ Run all of your tests at once. The output may look something like: Documentation ============= -The primary sources of documentation for |MPTEST| are this User's Manual, especially the :ref:`sec_mptest_reference` section, and the built-in ``help`` command. As with the built-in functions and toolbox routines in |MATLAB>| and |Octave>|, you can type ``help`` followed by the name of a command or M-file to get help on that particular function. +The primary sources of documentation for MP-Test are this User's Manual, especially the :ref:`sec_mptest_reference` section, and the built-in ``help`` command. As with the built-in functions and toolbox routines in |MATLAB>| and |Octave>|, you can type ``help`` followed by the name of a command or M-file to get help on that particular function. .. toctree:: @@ -125,7 +125,7 @@ Please see our `contributing guidelines `_. +MP-Test is distributed under the `3-clause BSD license `_. Acknowledgments =============== diff --git a/docs/sphinx/source/reference.rst b/docs/sphinx/source/reference.rst index a7e4182..95e6261 100644 --- a/docs/sphinx/source/reference.rst +++ b/docs/sphinx/source/reference.rst @@ -25,7 +25,7 @@ Other Functions --------------- Use these functions to test for availability and version information for -optional functionality and to check the version of the installed |MPTEST|. +optional functionality and to check the version of the installed MP-Test. .. toctree:: @@ -33,10 +33,10 @@ optional functionality and to check the version of the installed |MPTEST|. functions/mptestver -Tests of |MPTEST| ------------------ +Tests of MP-Test +---------------- -These functions test that |MPTEST| is installed and functioning as expected. +These functions test that MP-Test is installed and functioning as expected. .. toctree:: diff --git a/lib/mptestver.m b/lib/mptestver.m index ad25c48..d01680a 100644 --- a/lib/mptestver.m +++ b/lib/mptestver.m @@ -1,5 +1,5 @@ function rv = mptestver(varargin) -%mptestver - Prints or returns MP-Test version info. +%mptestver - Prints or returns installed MP-Test version info. % :: % % mptestver diff --git a/lib/t/t_have_feature.m b/lib/t/t_have_feature.m index a5c5e4e..6600750 100644 --- a/lib/t/t_have_feature.m +++ b/lib/t/t_have_feature.m @@ -3,6 +3,7 @@ function t_have_feature(quiet) % :: % % t_have_feature +% t_have_feature(quiet) % MP-Test % Copyright (c) 2004-2024, Power Systems Engineering Research Center (PSERC) diff --git a/lib/t/t_test_fcns.m b/lib/t/t_test_fcns.m index 4451754..953bcca 100644 --- a/lib/t/t_test_fcns.m +++ b/lib/t/t_test_fcns.m @@ -3,6 +3,7 @@ function t_test_fcns(quiet) % :: % % t_test_fcns +% t_test_fcns(quiet) % % Test t_ok, t_is, t_str_match, t_file_match and manually check output of % failed tests.