diff --git a/packages/python-packages/doc-warden/README.md b/packages/python-packages/doc-warden/README.md index 5b5713e1da8a..98826a328600 100644 --- a/packages/python-packages/doc-warden/README.md +++ b/packages/python-packages/doc-warden/README.md @@ -39,8 +39,12 @@ Example usage: /:> ward scan -d $(Build.SourcesDirectory) ``` +**Notes for example above** -Devops is a bit finicky with registering a console entry point, hence the `sudo` just on the installation. This is not required on machines that are NOT a hosted build agent. +* Devops is a bit finicky with registering a console entry point, hence the `sudo` just on the installation. `sudo` is only required on devops machines. +* Assumption is that the `.docsettings` file is placed at the root of the repository. + * To provide a different path (like `azure-sdk-for-java` does...), use: + * `ward scan -d $(Build.SourcesDirectory) -c $(Build.SourcesDirectory)/eng/.docsettings.yml` ##### Parameter Options diff --git a/packages/python-packages/doc-warden/warden/WardenConfiguration.py b/packages/python-packages/doc-warden/warden/WardenConfiguration.py index 7bd0449b0d25..1ddc3dd3b666 100644 --- a/packages/python-packages/doc-warden/warden/WardenConfiguration.py +++ b/packages/python-packages/doc-warden/warden/WardenConfiguration.py @@ -19,7 +19,7 @@ def __init__(self): help = 'The repo directory that this tool should be scanning.', required = True) parser.add_argument( - '-y', + '-c', '--config-location', dest = 'config_location', required = False,