Skip to content

DOCS: Removed the prompt character#2148

Merged
tlimoncelli merged 3 commits into
DNSControl:masterfrom
cafferata:docs-removed-the-dollar-sign
Mar 13, 2023
Merged

DOCS: Removed the prompt character#2148
tlimoncelli merged 3 commits into
DNSControl:masterfrom
cafferata:docs-removed-the-dollar-sign

Conversation

@cafferata
Copy link
Copy Markdown
Member

@cafferata cafferata commented Mar 12, 2023

Removed the prompt character. The origin comes from pull request StackExchange/dnscontrol/pull/2142.

@systemcrash
Copy link
Copy Markdown
Contributor

Helping users to get going is the priority here. Although the prevailing wisdom from sysadmins is that the # or the $ is there to prevent pasting dangerous commands.

@tlimoncelli
Copy link
Copy Markdown
Contributor

I usually only include the $ or # if I'm showing output. The $/# differentiates between commands and output.

In this case, I was showing some output but I removed it. Removing the prompt character makes sense.

@tlimoncelli
Copy link
Copy Markdown
Contributor

(continued)

The documentation/ci-cd-gitlab.md example has output but we do some formatting to separate it out. I'm not sure which way is better, but we should be consistent.

@cafferata cafferata changed the title DOCS: Removed the dollar sign from the shell commands DOCS: Removed the prompt character Mar 13, 2023
@cafferata
Copy link
Copy Markdown
Member Author

cafferata commented Mar 13, 2023

I looked for consistency, only these two spots showed prompt character. ☺️

I searched for:

```shell
$

@tlimoncelli tlimoncelli merged commit fb44262 into DNSControl:master Mar 13, 2023
@cafferata cafferata deleted the docs-removed-the-dollar-sign branch March 13, 2023 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants