CipherLabs
/
besu
mirror of https://github.com/hyperledger/besu
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove broken image links from styleguide (#1936)

Browse Source 
The CLI style guide has some broken links to the images. Removing the links for now.
Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>
pull/2/head
Arash 5 years ago committed by Lucas Saldanha
parent d5eeaced25
commit f5133aac48
1 changed files with 0 additions and 16 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 16
      CLI-STYLE-GUIDE.md

16
CLI-STYLE-GUIDE.md
Unescape View File

@ -137,8 +137,6 @@ Feedback to the user should always be clear, concise and avoid technical jargon.
Warnings should be used when an option has been successfully set but there may be other factors the user should take into consideration.
![Input Warning](docs/images/Warning.png)
**Color/text formatting:**
* **"WARNING" Label:** Bold, Bright - Yellow - ANSI 33
@ -152,8 +150,6 @@ There should be a clear line break before and after a warning to call attention
When a value cannot be applied, show a clear error message and provide context on how the error can be avoided.
![Input Error](docs/images/Error.png)
**Color/text formatting:**
* **"ERROR" Label:** Bold, Red - ANSI 31
@ -165,8 +161,6 @@ There should be a clear line break before and after an error to help call attent
If the error is caused by an unknown option, the following formatting should be followed:
![Input Unknown Error](docs/images/ErrorUnknown.png)
## Logging in the CLI
> **Note:** The patterns and functionality in this section are not currently implemented.
@ -217,30 +211,20 @@ Color and formatting is used to help users to easily scan and find relevant info
"Information" (i.e. "INFO") is status of what is currently happening or has happened. The lack of an error or warning indicates that things are running smoothly. Information should be output with "stdout".
![Warning](docs/images/LogInfo.png)
### Error
An "error" should be shown if a process cannot be completed. Errors should be output with "stderr". Errors should include a clear reason why the error has occurred.
![Log Error](docs/images/LogError.png)
### Warning
A "warning" is shown when a process has been completed but it did not go as expected. Warnings should be output with "stderr". Warnings should include a clear reason why the warning has occured.
![Log Warning](docs/images/LogWarning.png)
### Failure
A "failure" should be shown if a process cannot be completed. Details about the failure should follow the main failure statement. Failures should be output with "stderr".
![Log Failure](docs/images/LogFailure.png)
## Indicating Progress
> **Note:** The patterns and functionality in this section are not currently implemented.
We should always indicate that progress is being made so the user knows a process has not stalled. Progress indicators should only be included for TTY sessions (not in output) and can be turned off with the `--progress-enabled=false` flag. The progress indicator should appear on a new line below the last line of information. Once the process is complete, the progress indicator will move down to the next empty line. A progress indicator is not needed if a process takes less than a second.
![Log Warning](docs/images/Spinner.gif)

Write Preview
Loading…
Cancel
Save