tuxji commented on a change in pull request #502:
URL: https://github.com/apache/daffodil/pull/502#discussion_r596961115



##########
File path: daffodil-cli/README.md
##########
@@ -38,6 +38,7 @@ For more information about Daffodil, see 
https://daffodil.apache.org/.
 
 To execute Daffodil on Linux:
 
+<!-- markdownlint-disable commands-show-output -->
 ```bash
 $ ./bin/daffodil [options]

Review comment:
       Sure, we can just remove the leading $.  According to markdownlint, the 
shell prompt should be there if we show a command's output, but shouldn't be 
there if we don't show a command's output.  I didn't know what you would think 
about removing the dollar sign, so I simply added a comment to disable the 
warning although I did fix all the other warnings.  I won't bother to change 
the README again, but I expect whoever edits the README in the future will see 
that comment and be reminded to fix the warning by removing the dollar sign 
from the three places it appears instead.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to