Skip to content

Commit

Permalink
Merge pull request #990 from andrey-tech/issue-989
Browse files Browse the repository at this point in the history
Update docs: filename/directory in CLI
  • Loading branch information
kylekatarnls committed Nov 18, 2022
2 parents d99e952 + 99769a2 commit 31677bd
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ https://phpmd.org
.. image:: https://ci.appveyor.com/api/projects/status/pc08owbun2y00kwk?svg=true
:target: https://ci.appveyor.com/project/phpmd/phpmd
:alt: AppVeyor Build Status
.. image:: https://codecov.io/gh/phpmd/phpmd/branch/master/graph/badge.svg?token=XrBrvTLJeE

.. image:: https://codecov.io/gh/phpmd/phpmd/branch/master/graph/badge.svg?token=XrBrvTLJeE
:target: https://codecov.io/gh/phpmd/phpmd
:alt: Codecov Status

.. image:: https://scrutinizer-ci.com/g/phpmd/phpmd/badges/build.png?b=master
:target: https://scrutinizer-ci.com/g/phpmd/phpmd/build-status/master
:alt: Scrutinizer Build Status
Expand Down Expand Up @@ -49,7 +49,7 @@ See https://phpmd.org/download/index.html
Command line usage
------------------

Type ``phpmd [filename|directory] [report format] [ruleset file]``, i.e: ::
Type ``phpmd [filename|directory[,filename|directory[,...]]] [report format] [ruleset file]``, i.e: ::

mapi@arwen ~ $ phpmd php/PDepend/DbusUI/ xml rulesets.xml

Expand Down Expand Up @@ -95,8 +95,8 @@ The xml report would like like this:
</file>
</pmd>
You can pass a file name or a directory name containing PHP source
code to PHPMD.
You can pass a comma-separated string with list of file names
or a directory names, containing PHP source code to PHPMD.

The `PHPMD Phar distribution`__ includes the rule set files inside
its archive, even if the "rulesets/codesize.xml" parameter above looks
Expand Down
6 changes: 3 additions & 3 deletions src/site/rst/documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Command line usage
==================

Type phpmd [filename|directory] [report format] [ruleset file], i.e: ::
Type phpmd [filename|directory[,filename|directory[,...]]] [report format] [ruleset file], i.e: ::

mapi@arwen ~ $ phpmd PHP/Depend/DbusUI/ xml rulesets/codesize.xml
<?xml version="1.0" encoding="UTF-8" ?>
Expand All @@ -20,8 +20,8 @@ Type phpmd [filename|directory] [report format] [ruleset file], i.e: ::
</file>
</pmd>

You can pass a file name or a directory name containing PHP source
code to PHPMD.
You can pass a comma-separated string with list of file names
or a directory names, containing PHP source code to PHPMD.

The PHPMD Phar distribution includes the rule set files inside
its archive, even if the "rulesets/codesize.xml" parameter above looks
Expand Down

0 comments on commit 31677bd

Please sign in to comment.