dortania / dortania/bugtracker

Visual format of command line snippets

Open
#218 0 comments 0 reactions 0 assignees View on GitHub
error
Dominant language
No language data
Stars
123
Forks
8
PR merge metrics
No merged PRs in 30d

Description

Open Core Installation Guide
**Format issue with all code and command line snippets.**

Command line commands are included in the guides to allow users to copy, paste and run without having to write and debug these statements themselves. As such they can save significant time. However the current formatfing for code snippets leads to copy errors and new users attempting to execute commands that have been improperly copied.

An example of the current format is below. The command line code is partly selected, however this selection is not visible.

![image](https://user-images.githubusercontent.com/86342290/123138678-8d4bff80-d412-11eb-846c-003e48799e13.png)

There also is a shadow being generated below the code box that seems to be of random length. This shadow could be interpreted as copying the line below the code,. The shadow is actually a slider, however this is hugely unclear. I did not discover that it was a slider until analyzing this formatting to report its problems. The shadow/slider is defective because it has a completely non-obvious function that is not needed and also obtuse.

Here is another example.

![image](https://user-images.githubusercontent.com/86342290/123139035-fcc1ef00-d412-11eb-9f16-ad62f38c84f2.png)

Fix:

Please replace with Apple's styling for command line snippets. In the example screen shot below, the expected behaviour when copying a line, being able to see what has been selected, is obvious.

![image](https://user-images.githubusercontent.com/86342290/123137972-cafc5880-d411-11eb-91ab-2ebf482ec7fd.png)

There is no shadow or slider in Apple's formatting to obfuscate the function of the code formatting.

A Web developer should be able to copy and paste Apple's CSS styling and replace the current code with the Apple styling.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.