Skip to content

Commit

Permalink
Minor updates to Sphinx documentation.
Browse files Browse the repository at this point in the history
- Use MP-Test rather than |MPTEST| because it really gains us nothing.
  • Loading branch information
rdzman committed Mar 12, 2024
1 parent 2290e28 commit a10a7b2
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 14 deletions.
18 changes: 9 additions & 9 deletions docs/sphinx/source/index.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
<https://github.com/MATPOWER/mptest>`_ 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:`{<MPTEST>}` to denote the path to this
directory.
Expand All @@ -38,7 +38,7 @@ of MATLAB or Octave, including setting up your MATLAB/Octave path.
- :samp:`{<MPTEST>}/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
Expand Down Expand Up @@ -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::

Expand All @@ -125,7 +125,7 @@ Please see our `contributing guidelines <https://github.com/MATPOWER/mptest/blob
License
=======

|MPTEST| is distributed under the `3-clause BSD license <https://github.com/MATPOWER/mptest/blob/master/LICENSE>`_.
MP-Test is distributed under the `3-clause BSD license <https://github.com/MATPOWER/mptest/blob/master/LICENSE>`_.

Acknowledgments
===============
Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/source/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,18 @@ 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::

functions/have_feature
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::

Expand Down
2 changes: 1 addition & 1 deletion lib/mptestver.m
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions lib/t/t_have_feature.m
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
1 change: 1 addition & 0 deletions lib/t/t_test_fcns.m
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit a10a7b2

Please sign in to comment.