From b4fa7403d3d32add13569a7bf0d41a2ad278162b Mon Sep 17 00:00:00 2001 From: nprimo Date: Thu, 13 Oct 2022 12:20:41 +0100 Subject: [PATCH] docs(ascii-art-optionals): clarify subjects - Specify the behavior for programs with multiple optional projects implemented to avoid doubts during audits - Add clarification on default behaviour - program with only [STRING] argument --- subjects/ascii-art/color/README.md | 3 +++ subjects/ascii-art/fs/README.md | 3 +++ subjects/ascii-art/justify/README.md | 3 +++ subjects/ascii-art/output/README.md | 3 +++ subjects/ascii-art/reverse/README.md | 3 +++ 5 files changed, 15 insertions(+) diff --git a/subjects/ascii-art/color/README.md b/subjects/ascii-art/color/README.md index 5da792c7..d58bf011 100644 --- a/subjects/ascii-art/color/README.md +++ b/subjects/ascii-art/color/README.md @@ -16,6 +16,9 @@ Usage: go run . [STRING] [OPTION] EX: go run . something --color= ``` +If there are other `ascii-art` optional projects implemented, the program should accept other correctly formatted `[OPTION]` and/or `[BANNER]`. +Additionally, the program must still be able to run with a single `[STRING]` argument. + ### Instructions - Your project must be written in **Go**. diff --git a/subjects/ascii-art/fs/README.md b/subjects/ascii-art/fs/README.md index b8bc320f..5e51db4f 100644 --- a/subjects/ascii-art/fs/README.md +++ b/subjects/ascii-art/fs/README.md @@ -18,6 +18,9 @@ Usage: go run . [STRING] [BANNER] EX: go run . something standard ``` +If there are other `ascii-art` optional projects implemented, the program should accept other correctly formatted `[OPTION]` and/or `[BANNER]`. +Additionally, the program must still be able to run with a single `[STRING]` argument. + ### Usage ```console diff --git a/subjects/ascii-art/justify/README.md b/subjects/ascii-art/justify/README.md index d0f17c1a..588769a9 100644 --- a/subjects/ascii-art/justify/README.md +++ b/subjects/ascii-art/justify/README.md @@ -27,6 +27,9 @@ Usage: go run . [STRING] [BANNER] [OPTION] Example: go run . something standard --align=right ``` +If there are other `ascii-art` optional projects implemented, the program should accept other correctly formatted `[OPTION]` and/or `[BANNER]`. +Additionally, the program must still be able to run with a single `[STRING]` argument. + ### Instructions - Your project must be written in **Go**. diff --git a/subjects/ascii-art/output/README.md b/subjects/ascii-art/output/README.md index 09973d49..f1db5fa7 100644 --- a/subjects/ascii-art/output/README.md +++ b/subjects/ascii-art/output/README.md @@ -14,6 +14,9 @@ Usage: go run . [STRING] [BANNER] [OPTION] EX: go run . something standard --output= ``` +If there are other `ascii-art` optional projects implemented, the program should accept other correctly formatted `[OPTION]` and/or `[BANNER]`. +Additionally, the program must still be able to run with a single `[STRING]` argument. + ### Instructions - Your project must be written in **Go**. diff --git a/subjects/ascii-art/reverse/README.md b/subjects/ascii-art/reverse/README.md index 2a2d3238..654366db 100644 --- a/subjects/ascii-art/reverse/README.md +++ b/subjects/ascii-art/reverse/README.md @@ -16,6 +16,9 @@ Usage: go run . [OPTION] EX: go run . --reverse= ``` +If there are other `ascii-art` optional projects implemented, the program should accept other correctly formatted `[OPTION]` and/or `[BANNER]`. +Additionally, the program must still be able to run with a single `[STRING]` argument. + ### Instructions - Your project must be written in **Go**.