updating an argument shortcut, adding description to readme

Azure · Feb 14, 2019 · 4365c59 · 4365c59
1 parent 68b082c
commit 4365c59
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git 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
@@ -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,