DOC mention that lines starting with '#' in outputs are considered co…

…mments and should be ignored
BigDataBiology · Oct 8, 2024 · 6c0ceb4 · 6c0ceb4
1 parent 4d9db49
commit 6c0ceb4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -138,7 +138,8 @@ The following columns are added to the tsv outputs of ARG annotation tools:
 | `confers_resistance_to`      | ARO accessions of drugs to which ARGs confer resistance to                       |
 | `resistance_to_drug_classes` | ARO accessions of drugs classes to which drugs in `confers_resistance_to` belong |
 
-A comment is added to the very top of the ARG annotation tool outputs specifying the argNorm version used. For example: '# argNorm version: 0.6.0'
+A comment is added to the very top of the ARG annotation tool outputs specifying the argNorm version used. For example: '# argNorm version: 0.6.0'.
+> Lines starting with `#` should be considered comments and ignored
 
 ## Example 1: argNorm as a command line tool
 

diff --git a/docs/index.md b/docs/index.md
@@ -138,6 +138,7 @@ The following columns are added to the tsv outputs of ARG annotation tools:
 | `resistance_to_drug_classes` | ARO accessions of drugs classes to which drugs in `confers_resistance_to` belong |
 
 A comment is added to the very top of the ARG annotation tool outputs specifying the argNorm version used. For example: '# argNorm version: 0.6.0'
+> Lines starting with `#` should be considered comments and ignored
 
 ## Example 1: argNorm as a command line tool